elastic / elastic/crd-ref-docs

Support for outputting a file per kind

Open
#103 0 comments 6 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
173
Forks
81
PR merge metrics
No merged PRs in 30d

Description

In an internal documentation I have a file exists per resource/kind, so it would be nice to output the API references for each kind.

Example:
```
$ crd-ref-docs --source-path=./pkg/apis \
--config=config.yaml \
--renderer=markdown \
--output-path ./output \
--output-mode=kind

output
├── /v1alpha1/MyResource.md
├── /v1beta1/MyResource.md
└── /v1alpha1/MyOtherResource.md
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.