mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
54 lines
1.5 KiB
Markdown
54 lines
1.5 KiB
Markdown
|
---
|
||
|
|
date: 2019-07-31
|
||
|
|
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 https://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
|
||
|
|
-e, --environment string build environment
|
||
|
|
--ignoreVendor ignores any _vendor directory
|
||
|
|
--log enable Logging
|
||
|
|
--logFile string log File path (if set, logging enabled automatically)
|
||
|
|
--quiet build in quiet mode
|
||
|
|
-s, --source string filesystem path to read files relative from
|
||
|
|
--themesDir string filesystem path to themes directory
|
||
|
|
-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 31-Jul-2019
|