Man page - hugo-gen-doc(1)

Packages contains this manual

Manual

HUGO-GEN-DOC

NAME
SYNOPSIS
DESCRIPTION
OPTIONS
OPTIONS INHERITED FROM PARENT COMMANDS
SEE ALSO

NAME

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

SYNOPSIS

hugo gen doc [flags] [args]

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 https://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.

-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

-d , --destination =""

filesystem path to write files to

-e , --environment =""

build environment

--ignoreVendorPaths =""

ignores any _vendor for module paths matching the given Glob pattern

--logLevel =""

log level (debug|info|warn|error)

--quiet [=false]

build in quiet mode

-M , --renderToMemory [=false]

render to memory (mostly useful when running the server)

-s , --source =""

filesystem path to read files relative from

--themesDir =""

filesystem path to themes directory

-v , --verbose [=false]

verbose output

SEE ALSO

hugo-gen(1)