docs: Regen CLI docs

This commit is contained in:
Bjørn Erik Pedersen 2024-02-07 20:49:52 +01:00
parent 7cb447ab8e
commit 068ccde4c7
No known key found for this signature in database
42 changed files with 46 additions and 6 deletions

View file

@ -56,7 +56,7 @@ hugo [flags]
--printPathWarnings print warnings on duplicate target paths etc. --printPathWarnings print warnings on duplicate target paths etc.
--printUnusedTemplates print warnings on unused templates. --printUnusedTemplates print warnings on unused templates.
--quiet build in quiet mode --quiet build in quiet mode
--renderToMemory render to memory (only useful for benchmark testing) --renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--templateMetrics display metrics about template executions --templateMetrics display metrics about template executions
--templateMetricsHints calculate some improvement hints when combined with --templateMetrics --templateMetricsHints calculate some improvement hints when combined with --templateMetrics

View file

@ -31,6 +31,7 @@ See each sub-command's help for details on how to use the generated script.
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error) --logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode --quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory --themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output

View file

@ -54,6 +54,7 @@ hugo completion bash
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error) --logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode --quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory --themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output

View file

@ -45,6 +45,7 @@ hugo completion fish [flags]
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error) --logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode --quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory --themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output

View file

@ -42,6 +42,7 @@ hugo completion powershell [flags]
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error) --logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode --quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory --themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output

View file

@ -56,6 +56,7 @@ hugo completion zsh [flags]
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error) --logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode --quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory --themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output

View file

@ -39,6 +39,7 @@ hugo config [command] [flags]
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error) --logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode --quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory --themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output

View file

@ -33,6 +33,7 @@ hugo config mounts [flags] [args]
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error) --logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode --quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory --themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output

View file

@ -33,6 +33,7 @@ See convert's subcommands toJSON, toTOML and toYAML for more information.
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error) --logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode --quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory --themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output

View file

@ -35,6 +35,7 @@ hugo convert toJSON [flags] [args]
--logLevel string log level (debug|info|warn|error) --logLevel string log level (debug|info|warn|error)
-o, --output string filesystem path to write files to -o, --output string filesystem path to write files to
--quiet build in quiet mode --quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory --themesDir string filesystem path to themes directory
--unsafe enable less safe operations, please backup first --unsafe enable less safe operations, please backup first

View file

@ -35,6 +35,7 @@ hugo convert toTOML [flags] [args]
--logLevel string log level (debug|info|warn|error) --logLevel string log level (debug|info|warn|error)
-o, --output string filesystem path to write files to -o, --output string filesystem path to write files to
--quiet build in quiet mode --quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory --themesDir string filesystem path to themes directory
--unsafe enable less safe operations, please backup first --unsafe enable less safe operations, please backup first

View file

@ -35,6 +35,7 @@ hugo convert toYAML [flags] [args]
--logLevel string log level (debug|info|warn|error) --logLevel string log level (debug|info|warn|error)
-o, --output string filesystem path to write files to -o, --output string filesystem path to write files to
--quiet build in quiet mode --quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory --themesDir string filesystem path to themes directory
--unsafe enable less safe operations, please backup first --unsafe enable less safe operations, please backup first

View file

@ -44,6 +44,7 @@ hugo deploy [flags] [args]
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error) --logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode --quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory --themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output

View file

@ -33,6 +33,7 @@ hugo env [flags] [args]
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error) --logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode --quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory --themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output

View file

@ -25,6 +25,7 @@ A collection of several useful generators.
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error) --logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode --quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory --themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output

View file

@ -38,6 +38,7 @@ hugo gen chromastyles [flags] [args]
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error) --logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode --quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory --themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output

View file

@ -39,6 +39,7 @@ hugo gen doc [flags] [args]
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error) --logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode --quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory --themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output

View file

@ -36,6 +36,7 @@ hugo gen man [flags] [args]
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error) --logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode --quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory --themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output

View file

@ -31,6 +31,7 @@ Import requires a subcommand, e.g. `hugo import jekyll jekyll_root_path target_p
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error) --logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode --quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory --themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output

View file

@ -36,6 +36,7 @@ hugo import jekyll [flags] [args]
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error) --logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode --quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory --themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output

View file

@ -31,6 +31,7 @@ List requires a subcommand, e.g. hugo list drafts
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error) --logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode --quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory --themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output

View file

@ -33,6 +33,7 @@ hugo list all [flags] [args]
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error) --logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode --quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory --themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output

View file

@ -33,6 +33,7 @@ hugo list drafts [flags] [args]
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error) --logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode --quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory --themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output

View file

@ -33,6 +33,7 @@ hugo list expired [flags] [args]
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error) --logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode --quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory --themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output

View file

@ -33,6 +33,7 @@ hugo list future [flags] [args]
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error) --logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode --quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory --themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output

View file

@ -40,6 +40,7 @@ See https://gohugo.io/hugo-modules/ for more information.
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error) --logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode --quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory --themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output

View file

@ -39,6 +39,7 @@ hugo mod clean [flags] [args]
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error) --logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode --quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory --themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output

View file

@ -64,6 +64,7 @@ hugo mod get [flags] [args]
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error) --logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode --quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory --themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output

View file

@ -40,6 +40,7 @@ hugo mod graph [flags] [args]
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error) --logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode --quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory --themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output

View file

@ -44,6 +44,7 @@ hugo mod init [flags] [args]
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error) --logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode --quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory --themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output

View file

@ -33,6 +33,7 @@ hugo mod npm [command] [flags]
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error) --logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode --quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory --themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output

View file

@ -47,6 +47,7 @@ hugo mod npm pack [flags] [args]
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error) --logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode --quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory --themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output

View file

@ -33,6 +33,7 @@ hugo mod tidy [flags] [args]
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error) --logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode --quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory --themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output

View file

@ -39,6 +39,7 @@ hugo mod vendor [flags] [args]
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error) --logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode --quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory --themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output

View file

@ -38,6 +38,7 @@ hugo mod verify [flags] [args]
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error) --logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode --quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory --themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output

View file

@ -36,6 +36,7 @@ Ensure you run this within the root directory of your site.
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error) --logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode --quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory --themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output

View file

@ -47,6 +47,7 @@ hugo new content [path] [flags]
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error) --logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode --quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory --themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output

View file

@ -37,6 +37,7 @@ hugo new site [path] [flags]
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error) --logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode --quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory --themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output

View file

@ -36,6 +36,7 @@ hugo new theme [name] [flags]
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error) --logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode --quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory --themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output

View file

@ -12,8 +12,9 @@ A high performance webserver
Hugo provides its own webserver which builds and serves the site. Hugo provides its own webserver which builds and serves the site.
While hugo server is high performance, it is a webserver with limited options. While hugo server is high performance, it is a webserver with limited options.
'hugo server' will avoid writing the rendered and served content to disk, 'hugo server' will by default write and server files from disk, but you can
preferring to store it in memory. render to memory by using the '--renderToMemory' flag. This can be faster
in some cases, but it will consume more memory.
By default hugo will also watch your files for any changes you make and By default hugo will also watch your files for any changes you make and
automatically rebuild the site. It will then live reload any open browser pages automatically rebuild the site. It will then live reload any open browser pages
@ -47,8 +48,6 @@ hugo server [command] [flags]
--ignoreCache ignores the cache directory --ignoreCache ignores the cache directory
-l, --layoutDir string filesystem path to layout directory -l, --layoutDir string filesystem path to layout directory
--liveReloadPort int port for live reloading (i.e. 443 in HTTPS proxy situations) (default -1) --liveReloadPort int port for live reloading (i.e. 443 in HTTPS proxy situations) (default -1)
--meminterval string interval to poll memory usage (requires --memstats), valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". (default "100ms")
--memstats string log memory usage to this file
--minify minify any supported output format (HTML, XML etc.) --minify minify any supported output format (HTML, XML etc.)
--navigateToChanged navigate to changed content file on live browser reload --navigateToChanged navigate to changed content file on live browser reload
--noBuildLock don't create .hugo_build.lock file --noBuildLock don't create .hugo_build.lock file
@ -58,12 +57,12 @@ hugo server [command] [flags]
--panicOnWarning panic on first WARNING log --panicOnWarning panic on first WARNING log
--poll string set this to a poll interval, e.g --poll 700ms, to use a poll based approach to watch for file system changes --poll string set this to a poll interval, e.g --poll 700ms, to use a poll based approach to watch for file system changes
-p, --port int port on which the server will listen (default 1313) -p, --port int port on which the server will listen (default 1313)
--pprof enable the pprof server (port 8080)
--printI18nWarnings print missing translations --printI18nWarnings print missing translations
--printMemoryUsage print memory usage to screen at intervals --printMemoryUsage print memory usage to screen at intervals
--printPathWarnings print warnings on duplicate target paths etc. --printPathWarnings print warnings on duplicate target paths etc.
--printUnusedTemplates print warnings on unused templates. --printUnusedTemplates print warnings on unused templates.
--renderStaticToDisk serve static files from disk and dynamic files from memory --renderStaticToDisk serve static files from disk and dynamic files from memory
--renderToDisk serve all files from disk (default is from memory)
--templateMetrics display metrics about template executions --templateMetrics display metrics about template executions
--templateMetricsHints calculate some improvement hints when combined with --templateMetrics --templateMetricsHints calculate some improvement hints when combined with --templateMetrics
-t, --theme strings themes to use (located in /themes/THEMENAME/) -t, --theme strings themes to use (located in /themes/THEMENAME/)
@ -86,6 +85,7 @@ hugo server [command] [flags]
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error) --logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode --quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory --themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output

View file

@ -30,6 +30,7 @@ hugo server trust [flags] [args]
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error) --logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode --quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory --themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output

View file

@ -33,6 +33,7 @@ hugo version [flags] [args]
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--logLevel string log level (debug|info|warn|error) --logLevel string log level (debug|info|warn|error)
--quiet build in quiet mode --quiet build in quiet mode
--renderToMemory render to memory (mostly useful when running the server)
-s, --source string filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory --themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output