1HUGO-GEN-DOC(1)Apr(2020)                              HUGO-GEN-DOC(1)Apr(2020)
2
3
4
5Hugo 0.69.0 Hugo Manual
6
7

NAME

9       hugo-gen-doc - Generate Markdown documentation for the Hugo CLI.
10
11
12

SYNOPSIS

14       hugo gen doc [flags]
15
16
17

DESCRIPTION

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

OPTIONS

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

OPTIONS INHERITED FROM PARENT COMMANDS

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

SEE ALSO

78       hugo-gen(1)
79
80
81
82                                                      HUGO-GEN-DOC(1)Apr(2020)