hugo_gen_doc.md (1646B)
1 ---
2 title: "hugo gen doc"
3 slug: hugo_gen_doc
4 url: /commands/hugo_gen_doc/
5 ---
6 ## hugo gen doc
7
8 Generate Markdown documentation for the Hugo CLI.
9
10 ### Synopsis
11
12 Generate Markdown documentation for the Hugo CLI.
13
14 This command is, mostly, used to create up-to-date documentation
15 of Hugo's command-line interface for https://gohugo.io/.
16
17 It creates one Markdown file per command with front matter suitable
18 for rendering in Hugo.
19
20 ```
21 hugo gen doc [flags]
22 ```
23
24 ### Options
25
26 ```
27 --dir string the directory to write the doc. (default "/tmp/hugodoc/")
28 -h, --help help for doc
29 ```
30
31 ### Options inherited from parent commands
32
33 ```
34 --clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
35 --config string config file (default is path/config.yaml|json|toml)
36 --configDir string config dir (default "config")
37 --debug debug output
38 -e, --environment string build environment
39 --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
40 --log enable Logging
41 --logFile string log File path (if set, logging enabled automatically)
42 --quiet build in quiet mode
43 -s, --source string filesystem path to read files relative from
44 --themesDir string filesystem path to themes directory
45 -v, --verbose verbose output
46 --verboseLog verbose logging
47 ```
48
49 ### SEE ALSO
50
51 * [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
52