cli-docs-tool

Utilities to generate (reference) documentation for the docker CLI

Перейти к файлу

CrazyMax 88368f24e1 Update README Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>		2021-08-03 22:46:40 +02:00
.github	add code of conduct and contributing notes	2021-08-03 22:46:36 +02:00
example	readme for example	2021-08-03 22:46:38 +02:00
hack	Fix linter and add tests	2021-08-03 22:46:08 +02:00
.dockerignore	Rename package and move `LoadLongDescription` func	2021-08-03 22:46:09 +02:00
.editorconfig	README	2021-08-03 22:45:56 +02:00
.gitignore	Rename package and move `LoadLongDescription` func	2021-08-03 22:46:09 +02:00
LICENSE	License	2021-07-29 19:23:14 +02:00
README.md	Update README	2021-08-03 22:46:40 +02:00
docgen.go	Update README	2021-08-03 22:46:40 +02:00
docgen_md.go	docs: add external docs links support	2021-08-03 22:46:26 +02:00
docgen_md_test.go	Basic test	2021-08-03 22:46:23 +02:00
docgen_yaml.go	Add `GenTree` func	2021-08-03 22:46:16 +02:00
docgen_yaml_test.go	lint	2021-08-03 22:46:35 +02:00
docker-bake.hcl	Container based developer flow	2021-08-03 22:46:00 +02:00
go.mod	Refactor markdown generator	2021-08-03 22:46:14 +02:00
go.sum	Refactor markdown generator	2021-08-03 22:46:14 +02:00
markdown.go	Rename package and move `LoadLongDescription` func	2021-08-03 22:46:09 +02:00
markdown_test.go	Rename package and move `LoadLongDescription` func	2021-08-03 22:46:09 +02:00

About

Doc generator specially crafted for Docker CLI plugins.

go get github.com/docker/docgen

Basic usage available in example folder.

Want to contribute? Awesome! You can find information about contributing to this project in the CONTRIBUTING.md