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 https://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       --clock=""        set   the   clock   used   by   Hugo,   e.g.  --clock
38       2021-11-06T22:30:00.00+09:00
39
40
41       --config=""      config file (default is hugo.yaml|json|toml)
42
43
44       --configDir="config"      config dir
45
46
47       --debug[=false]      debug output
48
49
50       -e, --environment=""      build environment
51
52
53       --ignoreVendorPaths=""      ignores any _vendor for module paths match‐
54       ing the given Glob pattern
55
56
57       --log[=false]      enable Logging
58
59
60       --logFile=""      log File path (if set, logging enabled automatically)
61
62
63       --quiet[=false]      build in quiet mode
64
65
66       -s, --source=""      filesystem path to read files relative from
67
68
69       --themesDir=""      filesystem path to themes directory
70
71
72       -v, --verbose[=false]      verbose output
73
74
75       --verboseLog[=false]      verbose logging
76
77
78

SEE ALSO

80       hugo-gen(1)
81
82
83
84Hugo 0.111.3                       Jul 2023                    HUGO-GEN-DOC(1)
Impressum