mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
8b73644d81
0f2bf195e Adjust shortcodes for 0.55 48c577121 Fix deprecation warnings ed95a341a Update index.md e4bc8981f Release 0.55.0 25acacb91 Merge branch 'temp55' b240e321a releaser: Add release notes to /docs for release of 0.55.0 86a190c92 docs: Add information about summary front matter variable 9d94f4340 integrity: Add support for sha384 dd3fe9f92 Add HUGO_NUMWORKERMULTIPLIER 968372d86 Add trace.out to .gitignore 660772713 Add the Fireship images to cache 41a3e19cb hugolib: Allow page-relative aliases 4497e4b12 Update faq.md b0ee3dccc output: Add missing JSON tag 173dac0b7 docs: Regenerate docshelper data e30473062 docs: Regenerate CLI docs 8cb775be2 Merge commit 'c2037f0c9a3a35b9db9c404f6b5f94ec8b690a53' 5bc64bf44 Make Page an interface 371ff6c12 Add skipHTML option to blackfriday config git-subtree-dir: docs git-subtree-split: 0f2bf195ef549013cc843199fb50317b0d1a5e85
49 lines
1.2 KiB
Markdown
49 lines
1.2 KiB
Markdown
---
|
|
date: 2019-03-26
|
|
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 26-Mar-2019
|