larryh/corso
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix CLI auto-generated docs headers (#1845)

Browse Source 
## Description

Fixes warnings the H1 headers are missing

## Does this PR need a docs update or release note?

- [x] ⛔ No 

## Type of change

- [x] 🐛 Bugfix
- [x] 🗺️ Documentation
This commit is contained in:
Niraj Tolia 2022-12-16 13:10:05 -08:00 committed by GitHub
parent 99b0f51980
commit da869aeba7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/cmd/mdgen/mdgen.go
View File

@ -125,12 +125,9 @@ func genMarkdownCustomCorso(cmd *cobra.Command, w io.Writer) error {
// frontMatter section // frontMatter section
buf.WriteString("---\n") buf.WriteString("---\n")
buf.WriteString(fmt.Sprintf("title: %s\n", name)) buf.WriteString(fmt.Sprintf("title: %s\n", name))
buf.WriteString("hide_title: true\n") buf.WriteString("---\n\n")
buf.WriteString("---\n")
// actual markdown // actual markdown
buf.WriteString("## " + name + "\n\n")
if len(cmd.Long) > 0 { if len(cmd.Long) > 0 {
buf.WriteString(cmd.Long + "\n") buf.WriteString(cmd.Long + "\n")
} else { } else {
@ -144,21 +141,21 @@ func genMarkdownCustomCorso(cmd *cobra.Command, w io.Writer) error {
if cmd.HasExample() { if cmd.HasExample() {
buf.WriteString("\n") buf.WriteString("\n")
buf.WriteString("### Examples\n\n") buf.WriteString("## Examples\n\n")
buf.WriteString(fmt.Sprintf("```bash\n%s\n```\n", cmd.Example)) buf.WriteString(fmt.Sprintf("```bash\n%s\n```\n", cmd.Example))
} }
flags := cmd.NonInheritedFlags() flags := cmd.NonInheritedFlags()
if flags.HasAvailableFlags() { if flags.HasAvailableFlags() {
buf.WriteString("\n") buf.WriteString("\n")
buf.WriteString("### Flags\n\n") buf.WriteString("## Flags\n\n")
printFlags(buf, flags) printFlags(buf, flags)
} }
parentFlags := cmd.InheritedFlags() parentFlags := cmd.InheritedFlags()
if parentFlags.HasAvailableFlags() { if parentFlags.HasAvailableFlags() {
buf.WriteString("\n") buf.WriteString("\n")
buf.WriteString("### Global and inherited flags\n\n") buf.WriteString("## Global and inherited flags\n\n")
printFlags(buf, parentFlags) printFlags(buf, parentFlags)
} }