NAME¶

hugo-gen-doc - Generate Markdown documentation for the Hugo CLI.

SYNOPSIS¶

hugo gen doc [OPTIONS]

DESCRIPTION¶

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 ⟨http://gohugo.io/⟩.

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

OPTIONS¶

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

OPTIONS INHERITED FROM PARENT COMMANDS¶

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

--log[=false]
Enable Logging

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

--quiet[=false]
build in quiet mode

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

--verboseLog[=false]
verbose logging

SEE ALSO¶

hugo-gen(1)