Skip to content

Commit 12b7dfd

Browse files
authored
Remove extraneous line from generated markdown (#1311)
Signed-off-by: jolheiser <[email protected]>
1 parent 1259f1e commit 12b7dfd

7 files changed

+3
-13
lines changed

docs.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import (
1515
// The function errors if either parsing or writing of the string fails.
1616
func (a *App) ToMarkdown() (string, error) {
1717
var w bytes.Buffer
18-
if err := a.writeDocTemplate(&w, 8); err != nil {
18+
if err := a.writeDocTemplate(&w, 0); err != nil {
1919
return "", err
2020
}
2121
return w.String(), nil

template.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,9 +74,9 @@ OPTIONS:
7474
{{end}}{{end}}
7575
`
7676

77-
var MarkdownDocTemplate = `% {{ .App.Name }} {{ .SectionNum }}
77+
var MarkdownDocTemplate = `{{if gt .SectionNum 0}}% {{ .App.Name }} {{ .SectionNum }}
7878
79-
# NAME
79+
{{end}}# NAME
8080
8181
{{ .App.Name }}{{ if .App.Usage }} - {{ .App.Usage }}{{ end }}
8282

testdata/expected-doc-full.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
% greet 8
2-
31
# NAME
42

53
greet - Some app

testdata/expected-doc-no-authors.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
% greet 8
2-
31
# NAME
42

53
greet - Some app

testdata/expected-doc-no-commands.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
% greet 8
2-
31
# NAME
42

53
greet - Some app

testdata/expected-doc-no-flags.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
% greet 8
2-
31
# NAME
42

53
greet - Some app

testdata/expected-doc-no-usagetext.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
% greet 8
2-
31
# NAME
42

53
greet - Some app

0 commit comments

Comments
 (0)