mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
978856e2ad
785e375f5 Change 'my-another-post' to 'my-other-post' ba9a69d25 Update reflect.IsSlice.md 806344258 Update reflect.IsMap.md 757c0dafa Update index.md d3f20a2d5 Update index.md 9952e72a0 Formatting 70458ccf2 Formatting 7e0dd3969 Merge branch 'config-dir' 06a5c11fc Release 0.53 01c00229f releaser: Prepare repository for 0.54-DEV 29b223f78 releaser: Add release notes to /docs for release of 0.53 4f61d1194 releaser: Bump versions for release of 0.53 320a0ac68 Refactor config below /config ec16b611e docs: Adjust CSV example cecf97dfc Rename CSV option from comma to delimiter 18d06df58 docs: Document transform.Unmarshal fdace78b5 docs: Regenerate CLI docs b8f84ac59 hugolib: Add .Name as a shortcode variable 6612dd1b8 Merge commit '5a83bf314f4c0ce1d61341e0a1df21c9998e8154' 9b211089f docs: Regenerate CLI docs 9af46af3c Merge commit 'eb16165694f868d73e57b6aed5c26ba5e98229de' 12f46f356 tpl: Add reflect namespace git-subtree-dir: docs git-subtree-split: 785e375f577394c6f782ef51796e2efe88d52cbb
49 lines
1.2 KiB
Markdown
49 lines
1.2 KiB
Markdown
---
|
|
date: 2018-12-23
|
|
title: "hugo gen doc"
|
|
slug: hugo_gen_doc
|
|
url: /commands/hugo_gen_doc/
|
|
---
|
|
## hugo gen doc
|
|
|
|
Generate Markdown documentation for the Hugo CLI.
|
|
|
|
### Synopsis
|
|
|
|
Generate Markdown documentation for the Hugo CLI.
|
|
|
|
This command is, mostly, used to create up-to-date documentation
|
|
of Hugo's command-line interface for http://gohugo.io/.
|
|
|
|
It creates one Markdown file per command with front matter suitable
|
|
for rendering in Hugo.
|
|
|
|
```
|
|
hugo gen doc [flags]
|
|
```
|
|
|
|
### Options
|
|
|
|
```
|
|
--dir string the directory to write the doc. (default "/tmp/hugodoc/")
|
|
-h, --help help for doc
|
|
```
|
|
|
|
### Options inherited from parent commands
|
|
|
|
```
|
|
--config string config file (default is path/config.yaml|json|toml)
|
|
--configDir string config dir (default "config")
|
|
--debug debug output
|
|
--log enable Logging
|
|
--logFile string log File path (if set, logging enabled automatically)
|
|
--quiet build in quiet mode
|
|
-v, --verbose verbose output
|
|
--verboseLog verbose logging
|
|
```
|
|
|
|
### SEE ALSO
|
|
|
|
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
|
|
|
|
###### Auto generated by spf13/cobra on 23-Dec-2018
|