1HUGO-GEN-DOC(1)                   Hugo Manual                  HUGO-GEN-DOC(1)
2
3
4

NAME

6       hugo-gen-doc - Generate Markdown documentation for the Hugo CLI.
7
8
9

SYNOPSIS

11       hugo gen doc [flags]
12
13
14

DESCRIPTION

16       Generate Markdown documentation for the Hugo CLI.
17
18
19       This  command  is,  mostly,  used to create up-to-date documentation of
20       Hugo's command-line interface for http://gohugo.io/.
21
22
23       It creates one Markdown file per command with front matter suitable for
24       rendering in Hugo.
25
26
27

OPTIONS

29       --dir="/tmp/hugodoc/"      the directory to write the doc.
30
31
32       -h, --help[=false]      help for doc
33
34
35

OPTIONS INHERITED FROM PARENT COMMANDS

37       --config=""      config file (default is path/config.yaml|json|toml)
38
39
40       --configDir="config"      config dir
41
42
43       --debug[=false]      debug output
44
45
46       -e, --environment=""      build environment
47
48
49       --ignoreVendorPaths=""      ignores any _vendor for module paths match‐
50       ing the given Glob pattern
51
52
53       --log[=false]      enable Logging
54
55
56       --logFile=""      log File path (if set, logging enabled automatically)
57
58
59       --quiet[=false]      build in quiet mode
60
61
62       -s, --source=""      filesystem path to read files relative from
63
64
65       --themesDir=""      filesystem path to themes directory
66
67
68       -v, --verbose[=false]      verbose output
69
70
71       --verboseLog[=false]      verbose logging
72
73
74

SEE ALSO

76       hugo-gen(1)
77
78
79
80Hugo 0.93.3                        May 2022                    HUGO-GEN-DOC(1)