nicoeri/filebrowser
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: update docs generation

Browse Source 
License: MIT
Signed-off-by: Henrique Dias <hacdias@gmail.com>
This commit is contained in:
Henrique Dias 2019-01-05 15:20:06 +00:00
parent 2a434727e0
commit 093e7d9c71
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
cmd/docs.go
View File

@ -91,8 +91,8 @@ func generateMarkdown(cmd *cobra.Command, w io.Writer) {
long = short long = short
} }
buf.WriteString("---\ndescription: " + short + "\n---\n\n")
buf.WriteString("# " + name + "\n\n") buf.WriteString("# " + name + "\n\n")
buf.WriteString(short + "\n\n")
buf.WriteString("## Synopsis\n\n") buf.WriteString("## Synopsis\n\n")
buf.WriteString(long + "\n\n") buf.WriteString(long + "\n\n")
@ -122,7 +122,7 @@ func printOptions(buf *bytes.Buffer, cmd *cobra.Command, name string) {
parentFlags := cmd.InheritedFlags() parentFlags := cmd.InheritedFlags()
parentFlags.SetOutput(buf) parentFlags.SetOutput(buf)
if parentFlags.HasAvailableFlags() { if parentFlags.HasAvailableFlags() {
buf.WriteString("## Options inherited from parent commands\n\n```\n") buf.WriteString("### Inherited\n\n```\n")
parentFlags.PrintDefaults() parentFlags.PrintDefaults()
buf.WriteString("```\n") buf.WriteString("```\n")
} }