github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2025-04-07 02:12:49 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs: Regen CLI docs

Browse source
This commit is contained in:
Bjørn Erik Pedersen 2022-11-17 16:19:22 +01:00
parent 9f7fb0a73b
commit 0a019a1a59
No known key found for this signature in database
GPG key ID: 330E6E2BD4859D8F
9 changed files with 237 additions and 237 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/content/en/commands/hugo_config.md
View file

@ -18,23 +18,23 @@ hugo config [flags]
### Options ### Options
``` ```
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
-e, --environment string build environment
-h, --help help for config -h, --help help for config
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
--config string config file (default is path/config.yaml|json|toml) --config string config file (default is path/config.yaml|json|toml)
--configDir string config dir (default "config") --configDir string config dir (default "config")
--debug debug output --debug debug output
-e, --environment string build environment
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode --quiet build in quiet mode
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output
--verboseLog verbose logging --verboseLog verbose logging
``` ```

10
docs/content/en/commands/hugo_convert.md
View file

@ -16,25 +16,25 @@ See convert's subcommands toJSON, toTOML and toYAML for more information.
### Options ### Options
``` ```
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
-e, --environment string build environment
-h, --help help for convert -h, --help help for convert
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
-o, --output string filesystem path to write files to -o, --output string filesystem path to write files to
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
--unsafe enable less safe operations, please backup first --unsafe enable less safe operations, please backup first
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
--config string config file (default is path/config.yaml|json|toml) --config string config file (default is path/config.yaml|json|toml)
--configDir string config dir (default "config") --configDir string config dir (default "config")
--debug debug output --debug debug output
-e, --environment string build environment
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode --quiet build in quiet mode
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output
--verboseLog verbose logging --verboseLog verbose logging
``` ```

10
docs/content/en/commands/hugo_deploy.md
View file

@ -22,29 +22,29 @@ hugo deploy [flags]
### Options ### Options
``` ```
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
--confirm ask for confirmation before making changes to the target --confirm ask for confirmation before making changes to the target
--dryRun dry run --dryRun dry run
-e, --environment string build environment
--force force upload of all files --force force upload of all files
-h, --help help for deploy -h, --help help for deploy
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--invalidateCDN invalidate the CDN cache listed in the deployment target (default true) --invalidateCDN invalidate the CDN cache listed in the deployment target (default true)
--maxDeletes int maximum # of files to delete, or -1 to disable (default 256) --maxDeletes int maximum # of files to delete, or -1 to disable (default 256)
-s, --source string filesystem path to read files relative from
--target string target deployment from deployments section in config file; defaults to the first one --target string target deployment from deployments section in config file; defaults to the first one
--themesDir string filesystem path to themes directory
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
--config string config file (default is path/config.yaml|json|toml) --config string config file (default is path/config.yaml|json|toml)
--configDir string config dir (default "config") --configDir string config dir (default "config")
--debug debug output --debug debug output
-e, --environment string build environment
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode --quiet build in quiet mode
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output
--verboseLog verbose logging --verboseLog verbose logging
``` ```

10
docs/content/en/commands/hugo_list.md
View file

@ -16,23 +16,23 @@ List requires a subcommand, e.g. `hugo list drafts`.
### Options ### Options
``` ```
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
-e, --environment string build environment
-h, --help help for list -h, --help help for list
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
--config string config file (default is path/config.yaml|json|toml) --config string config file (default is path/config.yaml|json|toml)
--configDir string config dir (default "config") --configDir string config dir (default "config")
--debug debug output --debug debug output
-e, --environment string build environment
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode --quiet build in quiet mode
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output
--verboseLog verbose logging --verboseLog verbose logging
``` ```

10
docs/content/en/commands/hugo_mod.md
View file

@ -32,14 +32,17 @@ See https://gohugo.io/hugo-modules/ for more information.
-F, --buildFuture include content with publishdate in the future -F, --buildFuture include content with publishdate in the future
--cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ --cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
--cleanDestinationDir remove files from destination not found in static directories --cleanDestinationDir remove files from destination not found in static directories
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
-c, --contentDir string filesystem path to content directory -c, --contentDir string filesystem path to content directory
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
--disableKinds strings disable different kind of pages (home, RSS etc.) --disableKinds strings disable different kind of pages (home, RSS etc.)
--enableGitInfo add Git revision, date, author, and CODEOWNERS info to the pages --enableGitInfo add Git revision, date, author, and CODEOWNERS info to the pages
-e, --environment string build environment
--forceSyncStatic copy all files when static is changed. --forceSyncStatic copy all files when static is changed.
--gc enable to run some cleanup tasks (remove unused cache files) after the build --gc enable to run some cleanup tasks (remove unused cache files) after the build
-h, --help help for mod -h, --help help for mod
--ignoreCache ignores the cache directory --ignoreCache ignores the cache directory
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
-l, --layoutDir string filesystem path to layout directory -l, --layoutDir string filesystem path to layout directory
--minify minify any supported output format (HTML, XML etc.) --minify minify any supported output format (HTML, XML etc.)
--noBuildLock don't create .hugo_build.lock file --noBuildLock don't create .hugo_build.lock file
@ -51,26 +54,23 @@ See https://gohugo.io/hugo-modules/ for more information.
--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.
-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
-t, --theme strings themes to use (located in /themes/THEMENAME/) -t, --theme strings themes to use (located in /themes/THEMENAME/)
--themesDir string filesystem path to themes directory
--trace file write trace to file (not useful in general) --trace file write trace to file (not useful in general)
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
--config string config file (default is path/config.yaml|json|toml) --config string config file (default is path/config.yaml|json|toml)
--configDir string config dir (default "config") --configDir string config dir (default "config")
--debug debug output --debug debug output
-e, --environment string build environment
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode --quiet build in quiet mode
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output
--verboseLog verbose logging --verboseLog verbose logging
``` ```

10
docs/content/en/commands/hugo_new.md
View file

@ -31,16 +31,19 @@ hugo new [path] [flags]
-F, --buildFuture include content with publishdate in the future -F, --buildFuture include content with publishdate in the future
--cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ --cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
--cleanDestinationDir remove files from destination not found in static directories --cleanDestinationDir remove files from destination not found in static directories
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
-c, --contentDir string filesystem path to content directory -c, --contentDir string filesystem path to content directory
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
--disableKinds strings disable different kind of pages (home, RSS etc.) --disableKinds strings disable different kind of pages (home, RSS etc.)
--editor string edit new content with this editor, if provided --editor string edit new content with this editor, if provided
--enableGitInfo add Git revision, date, author, and CODEOWNERS info to the pages --enableGitInfo add Git revision, date, author, and CODEOWNERS info to the pages
-e, --environment string build environment
-f, --force overwrite file if it already exists -f, --force overwrite file if it already exists
--forceSyncStatic copy all files when static is changed. --forceSyncStatic copy all files when static is changed.
--gc enable to run some cleanup tasks (remove unused cache files) after the build --gc enable to run some cleanup tasks (remove unused cache files) after the build
-h, --help help for new -h, --help help for new
--ignoreCache ignores the cache directory --ignoreCache ignores the cache directory
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
-k, --kind string content type to create -k, --kind string content type to create
-l, --layoutDir string filesystem path to layout directory -l, --layoutDir string filesystem path to layout directory
--minify minify any supported output format (HTML, XML etc.) --minify minify any supported output format (HTML, XML etc.)
@ -53,26 +56,23 @@ hugo new [path] [flags]
--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.
-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
-t, --theme strings themes to use (located in /themes/THEMENAME/) -t, --theme strings themes to use (located in /themes/THEMENAME/)
--themesDir string filesystem path to themes directory
--trace file write trace to file (not useful in general) --trace file write trace to file (not useful in general)
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
--config string config file (default is path/config.yaml|json|toml) --config string config file (default is path/config.yaml|json|toml)
--configDir string config dir (default "config") --configDir string config dir (default "config")
--debug debug output --debug debug output
-e, --environment string build environment
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode --quiet build in quiet mode
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output
--verboseLog verbose logging --verboseLog verbose logging
``` ```

10
docs/content/en/commands/hugo_new_site.md
View file

@ -20,25 +20,25 @@ hugo new site [path] [flags]
### Options ### Options
``` ```
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
-e, --environment string build environment
--force init inside non-empty directory --force init inside non-empty directory
-f, --format string config file format (default "toml") -f, --format string config file format (default "toml")
-h, --help help for site -h, --help help for site
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
--config string config file (default is path/config.yaml|json|toml) --config string config file (default is path/config.yaml|json|toml)
--configDir string config dir (default "config") --configDir string config dir (default "config")
--debug debug output --debug debug output
-e, --environment string build environment
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode --quiet build in quiet mode
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output
--verboseLog verbose logging --verboseLog verbose logging
``` ```

10
docs/content/en/commands/hugo_new_theme.md
View file

@ -21,23 +21,23 @@ hugo new theme [name] [flags]
### Options ### Options
``` ```
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
-e, --environment string build environment
-h, --help help for theme -h, --help help for theme
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
--config string config file (default is path/config.yaml|json|toml) --config string config file (default is path/config.yaml|json|toml)
--configDir string config dir (default "config") --configDir string config dir (default "config")
--debug debug output --debug debug output
-e, --environment string build environment
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode --quiet build in quiet mode
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output
--verboseLog verbose logging --verboseLog verbose logging
``` ```

10
docs/content/en/commands/hugo_server.md
View file

@ -37,6 +37,7 @@ hugo server [flags]
-F, --buildFuture include content with publishdate in the future -F, --buildFuture include content with publishdate in the future
--cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ --cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
--cleanDestinationDir remove files from destination not found in static directories --cleanDestinationDir remove files from destination not found in static directories
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
-c, --contentDir string filesystem path to content directory -c, --contentDir string filesystem path to content directory
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
--disableBrowserError do not show build errors in the browser --disableBrowserError do not show build errors in the browser
@ -44,10 +45,12 @@ hugo server [flags]
--disableKinds strings disable different kind of pages (home, RSS etc.) --disableKinds strings disable different kind of pages (home, RSS etc.)
--disableLiveReload watch without enabling live browser reload on rebuild --disableLiveReload watch without enabling live browser reload on rebuild
--enableGitInfo add Git revision, date, author, and CODEOWNERS info to the pages --enableGitInfo add Git revision, date, author, and CODEOWNERS info to the pages
-e, --environment string build environment
--forceSyncStatic copy all files when static is changed. --forceSyncStatic copy all files when static is changed.
--gc enable to run some cleanup tasks (remove unused cache files) after the build --gc enable to run some cleanup tasks (remove unused cache files) after the build
-h, --help help for server -h, --help help for server
--ignoreCache ignores the cache directory --ignoreCache ignores the cache directory
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
-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") --meminterval string interval to poll memory usage (requires --memstats), valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". (default "100ms")
@ -67,9 +70,11 @@ hugo server [flags]
--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) --renderToDisk serve all files from disk (default is from memory)
-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
-t, --theme strings themes to use (located in /themes/THEMENAME/) -t, --theme strings themes to use (located in /themes/THEMENAME/)
--themesDir string filesystem path to themes directory
--trace file write trace to file (not useful in general) --trace file write trace to file (not useful in general)
-w, --watch watch filesystem for changes and recreate as needed (default true) -w, --watch watch filesystem for changes and recreate as needed (default true)
``` ```
@ -77,17 +82,12 @@ hugo server [flags]
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
--config string config file (default is path/config.yaml|json|toml) --config string config file (default is path/config.yaml|json|toml)
--configDir string config dir (default "config") --configDir string config dir (default "config")
--debug debug output --debug debug output
-e, --environment string build environment
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode --quiet build in quiet mode
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output -v, --verbose verbose output
--verboseLog verbose logging --verboseLog verbose logging
``` ```