.nh
.TH "HUGO-GEN-DOC" "1" "Mar 2024" "Hugo 0.124.1" "Hugo Manual"

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


.SH SYNOPSIS
.PP
\fBhugo gen doc [flags] [args]\fP


.SH DESCRIPTION
.PP
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/.

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

.EE


.SH OPTIONS
.PP
\fB--dir\fP="/tmp/hugodoc/"
	the directory to write the doc.

.PP
\fB-h\fP, \fB--help\fP[=false]
	help for doc


.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB--clock\fP=""
	set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00

.PP
\fB--config\fP=""
	config file (default is hugo.yaml|json|toml)

.PP
\fB--configDir\fP="config"
	config dir

.PP
\fB--debug\fP[=false]
	debug output

.PP
\fB-d\fP, \fB--destination\fP=""
	filesystem path to write files to

.PP
\fB-e\fP, \fB--environment\fP=""
	build environment

.PP
\fB--ignoreVendorPaths\fP=""
	ignores any _vendor for module paths matching the given Glob pattern

.PP
\fB--logLevel\fP=""
	log level (debug|info|warn|error)

.PP
\fB--quiet\fP[=false]
	build in quiet mode

.PP
\fB--renderToMemory\fP[=false]
	render to memory (mostly useful when running the server)

.PP
\fB-s\fP, \fB--source\fP=""
	filesystem path to read files relative from

.PP
\fB--themesDir\fP=""
	filesystem path to themes directory

.PP
\fB-v\fP, \fB--verbose\fP[=false]
	verbose output


.SH SEE ALSO
.PP
\fBhugo-gen(1)\fP