From da869aeba7d2ed47a6de145564175898971ed658 Mon Sep 17 00:00:00 2001 From: Niraj Tolia Date: Fri, 16 Dec 2022 13:10:05 -0800 Subject: [PATCH] Fix CLI auto-generated docs headers (#1845) ## Description Fixes warnings the H1 headers are missing ## Does this PR need a docs update or release note? - [x] :no_entry: No ## Type of change - [x] :bug: Bugfix - [x] :world_map: Documentation --- src/cmd/mdgen/mdgen.go | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/src/cmd/mdgen/mdgen.go b/src/cmd/mdgen/mdgen.go index bc5d7994f..d7396806c 100644 --- a/src/cmd/mdgen/mdgen.go +++ b/src/cmd/mdgen/mdgen.go @@ -125,12 +125,9 @@ func genMarkdownCustomCorso(cmd *cobra.Command, w io.Writer) error { // frontMatter section buf.WriteString("---\n") buf.WriteString(fmt.Sprintf("title: %s\n", name)) - buf.WriteString("hide_title: true\n") - buf.WriteString("---\n") + buf.WriteString("---\n\n") // actual markdown - buf.WriteString("## " + name + "\n\n") - if len(cmd.Long) > 0 { buf.WriteString(cmd.Long + "\n") } else { @@ -144,21 +141,21 @@ func genMarkdownCustomCorso(cmd *cobra.Command, w io.Writer) error { if cmd.HasExample() { buf.WriteString("\n") - buf.WriteString("### Examples\n\n") + buf.WriteString("## Examples\n\n") buf.WriteString(fmt.Sprintf("```bash\n%s\n```\n", cmd.Example)) } flags := cmd.NonInheritedFlags() if flags.HasAvailableFlags() { buf.WriteString("\n") - buf.WriteString("### Flags\n\n") + buf.WriteString("## Flags\n\n") printFlags(buf, flags) } parentFlags := cmd.InheritedFlags() if parentFlags.HasAvailableFlags() { buf.WriteString("\n") - buf.WriteString("### Global and inherited flags\n\n") + buf.WriteString("## Global and inherited flags\n\n") printFlags(buf, parentFlags) }