From 186b1c3ef0abb660e261e7e2b02a1421ad903a59 Mon Sep 17 00:00:00 2001 From: Shahidh Date: Sat, 7 Oct 2017 21:08:37 +0530 Subject: [PATCH] remove repetitive doc generating headings, combine all to one heading --- README.md | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 77f144b6..bc5ee0d2 100644 --- a/README.md +++ b/README.md @@ -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