glenux-archive/spf13--cobra
1
0
Fork 0
mirror of https://github.com/spf13/cobra synced 2025-05-06 05:17:21 +00:00
Code Issues Projects Releases Packages Wiki Activity

remove repetitive doc generating headings, combine all to one heading

Browse source
This commit is contained in:
Shahidh 2017-10-07 21:08:37 +05:30
parent 83e1b0eeb5
commit 186b1c3ef0
No known key found for this signature in database
GPG key ID: 9903E455C1B45ECD
1 changed files with 5 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -902,17 +902,13 @@ Did you mean this?
Run 'kubectl help' for usage.
```
## Generating Markdown-formatted documentation for your command
## Generating documentation for your command
Cobra can generate a Markdown-formatted document based on the subcommands, flags, etc. A simple example of how to do this for your command can be found in [Markdown Docs](doc/md_docs.md).
Cobra can generate documentation in the following formats based on subcommands, flags, etc.:
## Generating reStructured Text-formatted documentation for your command
Cobra can generate a reStructured Text-formatted document based on the subcommands, flags, etc. A simple example of how to do this for your command can be found in [ReST Docs](doc/rest_docs.md).
## Generating man pages for your command
Cobra can generate a man page based on the subcommands, flags, etc. A simple example of how to do this for your command can be found in [Man Docs](doc/man_docs.md).
- [Markdown](doc/md_docs.md)
- [ReStructured Text](doc/rest_docs.md)
- [Man Page](doc/man_docs.md)
## Generating bash completions for your command