glenux-archive/spf13--cobra
1
0
Fork 0
mirror of https://github.com/spf13/cobra synced 2024-11-04 21:07:19 +00:00
Code Issues Projects Releases Packages Wiki Activity

feat: #1140 updating doc gen docs for new method

Browse source
This commit is contained in:
Alexander Miranda 2024-06-19 13:31:07 -05:00
parent c71ca75519
commit 53bc9d3219
No known key found for this signature in database
GPG key ID: 22010069FB6DBA40
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
site/content/docgen/md.md
View file

@ -79,6 +79,12 @@ func GenMarkdownTreeCustom(cmd *Command, dir string, filePrepender, linkHandler
} }
``` ```
```go
func GenMarkdownTreeCustomWithFooter(cmd *Command, dir string, filePrepender, fileAppender, linkHandler func(string) string) error {
//...
}
```
```go ```go
func GenMarkdownCustom(cmd *Command, out *bytes.Buffer, linkHandler func(string) string) error { func GenMarkdownCustom(cmd *Command, out *bytes.Buffer, linkHandler func(string) string) error {
//... //...
@ -105,6 +111,8 @@ filePrepender := func(filename string) string {
} }
``` ```
The `fileAppender` will append the return value given the full filepath to the rendered Markdown file.
The `linkHandler` can be used to customize the rendered internal links to the commands, given a filename: The `linkHandler` can be used to customize the rendered internal links to the commands, given a filename:
```go ```go