hugo-gen-doc - Man Page

Generate Markdown documentation for the Hugo CLI.


hugo gen doc [flags]


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

It creates one Markdown file per command with front matter suitable for rendering in Hugo.


--dir="/tmp/hugodoc/" the directory to write the doc.

-h, --help[=false] help for doc

Options Inherited from Parent Commands

--clock="" set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00

--config="" config file (default is hugo.yaml|json|toml)

--configDir="config" config dir

--debug[=false] debug output

-e, --environment="" build environment

--ignoreVendorPaths="" ignores any _vendor for module paths matching the given Glob pattern

--log[=false] enable Logging

--logFile="" log File path (if set, logging enabled automatically)

--quiet[=false] build in quiet mode

-s, --source="" filesystem path to read files relative from

--themesDir="" filesystem path to themes directory

-v, --verbose[=false] verbose output

--verboseLog[=false] verbose logging

See Also


Referenced By


Aug 2023 Hugo 0.111.3 Hugo Manual