crd-to-markdown
Description
Goal of this command project is to generate markdown file that document CRD definition.
This project is base on the
po-docgenused in the prometheus-operator
How to use it
$ ./crd-to-markdown --help
Usage of ./crd-to-markdown:
-n, --crd-name SetStrings root crd stuct
-f, --file stringArray list of types.go files
--footer string .md file to be include as footer of the generate doc (default "footer.md")
--header string .md file to be include as header of the generate doc (default "header.md")
--links string list of external structs document links (default "links.csv")example:
$ ./crd-to-markdown -f ~/datadog-operator/api/v1alpha1/datadogagent_types.go -n DatadogAgentresult: https://gist.github.com/clamoriniere/f543ea634d04d74455bc2afb8efca7a4
How to build it
$ GO111MODULE=on go build .
