diff options
author | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2022-11-17 16:19:22 +0100 |
---|---|---|
committer | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2022-11-17 16:19:22 +0100 |
commit | 0a019a1a59718128ef4d61dfb99422844b53e30c (patch) | |
tree | adb0c3dc2438fa6d85b0f85499c2cafe0980042b /docs/content | |
parent | 9f7fb0a73bd56cb5fc002fadeb1357fcd14f9c2c (diff) |
docs: Regen CLI docs
Diffstat (limited to 'docs/content')
-rw-r--r-- | docs/content/en/commands/hugo_config.md | 28 | ||||
-rw-r--r-- | docs/content/en/commands/hugo_convert.md | 32 | ||||
-rw-r--r-- | docs/content/en/commands/hugo_deploy.md | 40 | ||||
-rw-r--r-- | docs/content/en/commands/hugo_list.md | 28 | ||||
-rw-r--r-- | docs/content/en/commands/hugo_mod.md | 84 | ||||
-rw-r--r-- | docs/content/en/commands/hugo_new.md | 90 | ||||
-rw-r--r-- | docs/content/en/commands/hugo_new_site.md | 32 | ||||
-rw-r--r-- | docs/content/en/commands/hugo_new_theme.md | 28 | ||||
-rw-r--r-- | docs/content/en/commands/hugo_server.md | 112 |
9 files changed, 237 insertions, 237 deletions
diff --git a/docs/content/en/commands/hugo_config.md b/docs/content/en/commands/hugo_config.md index e751416cc..f1a875ab5 100644 --- a/docs/content/en/commands/hugo_config.md +++ b/docs/content/en/commands/hugo_config.md @@ -18,25 +18,25 @@ hugo config [flags] ### Options ``` - -h, --help help for config -``` - -### 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) - --configDir string config dir (default "config") - --debug debug output -e, --environment string build environment + -h, --help help for config --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern - --log enable Logging - --logFile string log File path (if set, logging enabled automatically) - --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 - --verboseLog verbose logging +``` + +### Options inherited from parent commands + +``` + --config string config file (default is path/config.yaml|json|toml) + --configDir string config dir (default "config") + --debug debug output + --log enable Logging + --logFile string log File path (if set, logging enabled automatically) + --quiet build in quiet mode + -v, --verbose verbose output + --verboseLog verbose logging ``` ### SEE ALSO diff --git a/docs/content/en/commands/hugo_convert.md b/docs/content/en/commands/hugo_convert.md index 2e5e9aa6a..b85bfb7e0 100644 --- a/docs/content/en/commands/hugo_convert.md +++ b/docs/content/en/commands/hugo_convert.md @@ -16,27 +16,27 @@ See convert's subcommands toJSON, toTOML and toYAML for more information. ### Options ``` - -h, --help help for convert - -o, --output string filesystem path to write files to - --unsafe enable less safe operations, please backup first -``` - -### 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) - --configDir string config dir (default "config") - --debug debug output -e, --environment string build environment + -h, --help help for convert --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern - --log enable Logging - --logFile string log File path (if set, logging enabled automatically) - --quiet build in quiet mode + -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 - -v, --verbose verbose output - --verboseLog verbose logging + --unsafe enable less safe operations, please backup first +``` + +### Options inherited from parent commands + +``` + --config string config file (default is path/config.yaml|json|toml) + --configDir string config dir (default "config") + --debug debug output + --log enable Logging + --logFile string log File path (if set, logging enabled automatically) + --quiet build in quiet mode + -v, --verbose verbose output + --verboseLog verbose logging ``` ### SEE ALSO diff --git a/docs/content/en/commands/hugo_deploy.md b/docs/content/en/commands/hugo_deploy.md index b8638c674..f9d8e83fb 100644 --- a/docs/content/en/commands/hugo_deploy.md +++ b/docs/content/en/commands/hugo_deploy.md @@ -22,31 +22,31 @@ hugo deploy [flags] ### Options ``` - --confirm ask for confirmation before making changes to the target - --dryRun dry run - --force force upload of all files - -h, --help help for deploy - --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) - --target string target deployment from deployments section in config file; defaults to the first one -``` - -### 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) - --configDir string config dir (default "config") - --debug debug output + --confirm ask for confirmation before making changes to the target + --dryRun dry run -e, --environment string build environment + --force force upload of all files + -h, --help help for deploy --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern - --log enable Logging - --logFile string log File path (if set, logging enabled automatically) - --quiet build in quiet mode + --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) -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 --themesDir string filesystem path to themes directory - -v, --verbose verbose output - --verboseLog verbose logging +``` + +### Options inherited from parent commands + +``` + --config string config file (default is path/config.yaml|json|toml) + --configDir string config dir (default "config") + --debug debug output + --log enable Logging + --logFile string log File path (if set, logging enabled automatically) + --quiet build in quiet mode + -v, --verbose verbose output + --verboseLog verbose logging ``` ### SEE ALSO diff --git a/docs/content/en/commands/hugo_list.md b/docs/content/en/commands/hugo_list.md index 4099d01ee..6ef2bbd68 100644 --- a/docs/content/en/commands/hugo_list.md +++ b/docs/content/en/commands/hugo_list.md @@ -16,25 +16,25 @@ List requires a subcommand, e.g. `hugo list drafts`. ### Options ``` - -h, --help help for list -``` - -### 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) - --configDir string config dir (default "config") - --debug debug output -e, --environment string build environment + -h, --help help for list --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern - --log enable Logging - --logFile string log File path (if set, logging enabled automatically) - --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 - --verboseLog verbose logging +``` + +### Options inherited from parent commands + +``` + --config string config file (default is path/config.yaml|json|toml) + --configDir string config dir (default "config") + --debug debug output + --log enable Logging + --logFile string log File path (if set, logging enabled automatically) + --quiet build in quiet mode + -v, --verbose verbose output + --verboseLog verbose logging ``` ### SEE ALSO diff --git a/docs/content/en/commands/hugo_mod.md b/docs/content/en/commands/hugo_mod.md index 91cd7c743..6678e433f 100644 --- a/docs/content/en/commands/hugo_mod.md +++ b/docs/content/en/commands/hugo_mod.md @@ -26,53 +26,53 @@ See https://gohugo.io/hugo-modules/ for more information. ### Options ``` - -b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/ - -D, --buildDrafts include content marked as draft - -E, --buildExpired include expired content - -F, --buildFuture include content with publishdate in the future - --cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ - --cleanDestinationDir remove files from destination not found in static directories - -c, --contentDir string filesystem path to content directory - -d, --destination string filesystem path to write files to - --disableKinds strings disable different kind of pages (home, RSS etc.) - --enableGitInfo add Git revision, date, author, and CODEOWNERS info to the pages - --forceSyncStatic copy all files when static is changed. - --gc enable to run some cleanup tasks (remove unused cache files) after the build - -h, --help help for mod - --ignoreCache ignores the cache directory - -l, --layoutDir string filesystem path to layout directory - --minify minify any supported output format (HTML, XML etc.) - --noBuildLock don't create .hugo_build.lock file - --noChmod don't sync permission mode of files - --noTimes don't sync modification time of files - --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 - --printI18nWarnings print missing translations - --printMemoryUsage print memory usage to screen at intervals - --printPathWarnings print warnings on duplicate target paths etc. - --printUnusedTemplates print warnings on unused templates. - --templateMetrics display metrics about template executions - --templateMetricsHints calculate some improvement hints when combined with --templateMetrics - -t, --theme strings themes to use (located in /themes/THEMENAME/) - --trace file write trace to file (not useful in general) -``` - -### Options inherited from parent commands - -``` + -b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/ + -D, --buildDrafts include content marked as draft + -E, --buildExpired include expired content + -F, --buildFuture include content with publishdate in the future + --cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ + --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 - --config string config file (default is path/config.yaml|json|toml) - --configDir string config dir (default "config") - --debug debug output + -c, --contentDir string filesystem path to content directory + -d, --destination string filesystem path to write files to + --disableKinds strings disable different kind of pages (home, RSS etc.) + --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. + --gc enable to run some cleanup tasks (remove unused cache files) after the build + -h, --help help for mod + --ignoreCache ignores the cache directory --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern - --log enable Logging - --logFile string log File path (if set, logging enabled automatically) - --quiet build in quiet mode + -l, --layoutDir string filesystem path to layout directory + --minify minify any supported output format (HTML, XML etc.) + --noBuildLock don't create .hugo_build.lock file + --noChmod don't sync permission mode of files + --noTimes don't sync modification time of files + --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 + --printI18nWarnings print missing translations + --printMemoryUsage print memory usage to screen at intervals + --printPathWarnings print warnings on duplicate target paths etc. + --printUnusedTemplates print warnings on unused templates. -s, --source string filesystem path to read files relative from + --templateMetrics display metrics about template executions + --templateMetricsHints calculate some improvement hints when combined with --templateMetrics + -t, --theme strings themes to use (located in /themes/THEMENAME/) --themesDir string filesystem path to themes directory - -v, --verbose verbose output - --verboseLog verbose logging + --trace file write trace to file (not useful in general) +``` + +### Options inherited from parent commands + +``` + --config string config file (default is path/config.yaml|json|toml) + --configDir string config dir (default "config") + --debug debug output + --log enable Logging + --logFile string log File path (if set, logging enabled automatically) + --quiet build in quiet mode + -v, --verbose verbose output + --verboseLog verbose logging ``` ### SEE ALSO diff --git a/docs/content/en/commands/hugo_new.md b/docs/content/en/commands/hugo_new.md index 5d044b60b..5ca850c3b 100644 --- a/docs/content/en/commands/hugo_new.md +++ b/docs/content/en/commands/hugo_new.md @@ -25,56 +25,56 @@ hugo new [path] [flags] ### Options ``` - -b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/ - -D, --buildDrafts include content marked as draft - -E, --buildExpired include expired content - -F, --buildFuture include content with publishdate in the future - --cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ - --cleanDestinationDir remove files from destination not found in static directories - -c, --contentDir string filesystem path to content directory - -d, --destination string filesystem path to write files to - --disableKinds strings disable different kind of pages (home, RSS etc.) - --editor string edit new content with this editor, if provided - --enableGitInfo add Git revision, date, author, and CODEOWNERS info to the pages - -f, --force overwrite file if it already exists - --forceSyncStatic copy all files when static is changed. - --gc enable to run some cleanup tasks (remove unused cache files) after the build - -h, --help help for new - --ignoreCache ignores the cache directory - -k, --kind string content type to create - -l, --layoutDir string filesystem path to layout directory - --minify minify any supported output format (HTML, XML etc.) - --noBuildLock don't create .hugo_build.lock file - --noChmod don't sync permission mode of files - --noTimes don't sync modification time of files - --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 - --printI18nWarnings print missing translations - --printMemoryUsage print memory usage to screen at intervals - --printPathWarnings print warnings on duplicate target paths etc. - --printUnusedTemplates print warnings on unused templates. - --templateMetrics display metrics about template executions - --templateMetricsHints calculate some improvement hints when combined with --templateMetrics - -t, --theme strings themes to use (located in /themes/THEMENAME/) - --trace file write trace to file (not useful in general) -``` - -### Options inherited from parent commands - -``` + -b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/ + -D, --buildDrafts include content marked as draft + -E, --buildExpired include expired content + -F, --buildFuture include content with publishdate in the future + --cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ + --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 - --config string config file (default is path/config.yaml|json|toml) - --configDir string config dir (default "config") - --debug debug output + -c, --contentDir string filesystem path to content directory + -d, --destination string filesystem path to write files to + --disableKinds strings disable different kind of pages (home, RSS etc.) + --editor string edit new content with this editor, if provided + --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 + --forceSyncStatic copy all files when static is changed. + --gc enable to run some cleanup tasks (remove unused cache files) after the build + -h, --help help for new + --ignoreCache ignores the cache directory --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern - --log enable Logging - --logFile string log File path (if set, logging enabled automatically) - --quiet build in quiet mode + -k, --kind string content type to create + -l, --layoutDir string filesystem path to layout directory + --minify minify any supported output format (HTML, XML etc.) + --noBuildLock don't create .hugo_build.lock file + --noChmod don't sync permission mode of files + --noTimes don't sync modification time of files + --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 + --printI18nWarnings print missing translations + --printMemoryUsage print memory usage to screen at intervals + --printPathWarnings print warnings on duplicate target paths etc. + --printUnusedTemplates print warnings on unused templates. -s, --source string filesystem path to read files relative from + --templateMetrics display metrics about template executions + --templateMetricsHints calculate some improvement hints when combined with --templateMetrics + -t, --theme strings themes to use (located in /themes/THEMENAME/) --themesDir string filesystem path to themes directory - -v, --verbose verbose output - --verboseLog verbose logging + --trace file write trace to file (not useful in general) +``` + +### Options inherited from parent commands + +``` + --config string config file (default is path/config.yaml|json|toml) + --configDir string config dir (default "config") + --debug debug output + --log enable Logging + --logFile string log File path (if set, logging enabled automatically) + --quiet build in quiet mode + -v, --verbose verbose output + --verboseLog verbose logging ``` ### SEE ALSO diff --git a/docs/content/en/commands/hugo_new_site.md b/docs/content/en/commands/hugo_new_site.md index 10ef7c7ae..e0bd35c17 100644 --- a/docs/content/en/commands/hugo_new_site.md +++ b/docs/content/en/commands/hugo_new_site.md @@ -20,27 +20,27 @@ hugo new site [path] [flags] ### Options ``` - --force init inside non-empty directory - -f, --format string config file format (default "toml") - -h, --help help for site -``` - -### 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) - --configDir string config dir (default "config") - --debug debug output -e, --environment string build environment + --force init inside non-empty directory + -f, --format string config file format (default "toml") + -h, --help help for site --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern - --log enable Logging - --logFile string log File path (if set, logging enabled automatically) - --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 - --verboseLog verbose logging +``` + +### Options inherited from parent commands + +``` + --config string config file (default is path/config.yaml|json|toml) + --configDir string config dir (default "config") + --debug debug output + --log enable Logging + --logFile string log File path (if set, logging enabled automatically) + --quiet build in quiet mode + -v, --verbose verbose output + --verboseLog verbose logging ``` ### SEE ALSO diff --git a/docs/content/en/commands/hugo_new_theme.md b/docs/content/en/commands/hugo_new_theme.md index 5d2d40216..822bce543 100644 --- a/docs/content/en/commands/hugo_new_theme.md +++ b/docs/content/en/commands/hugo_new_theme.md @@ -21,25 +21,25 @@ hugo new theme [name] [flags] ### Options ``` - -h, --help help for theme -``` - -### 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) - --configDir string config dir (default "config") - --debug debug output -e, --environment string build environment + -h, --help help for theme --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern - --log enable Logging - --logFile string log File path (if set, logging enabled automatically) - --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 - --verboseLog verbose logging +``` + +### Options inherited from parent commands + +``` + --config string config file (default is path/config.yaml|json|toml) + --configDir string config dir (default "config") + --debug debug output + --log enable Logging + --logFile string log File path (if set, logging enabled automatically) + --quiet build in quiet mode + -v, --verbose verbose output + --verboseLog verbose logging ``` ### SEE ALSO diff --git a/docs/content/en/commands/hugo_server.md b/docs/content/en/commands/hugo_server.md index f79a8d5e9..62a3938e4 100644 --- a/docs/content/en/commands/hugo_server.md +++ b/docs/content/en/commands/hugo_server.md @@ -29,67 +29,67 @@ hugo server [flags] ### Options ``` - --appendPort append port to baseURL (default true) - -b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/ - --bind string interface to which the server will bind (default "127.0.0.1") - -D, --buildDrafts include content marked as draft - -E, --buildExpired include expired content - -F, --buildFuture include content with publishdate in the future - --cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ - --cleanDestinationDir remove files from destination not found in static directories - -c, --contentDir string filesystem path to content directory - -d, --destination string filesystem path to write files to - --disableBrowserError do not show build errors in the browser - --disableFastRender enables full re-renders on changes - --disableKinds strings disable different kind of pages (home, RSS etc.) - --disableLiveReload watch without enabling live browser reload on rebuild - --enableGitInfo add Git revision, date, author, and CODEOWNERS info to the pages - --forceSyncStatic copy all files when static is changed. - --gc enable to run some cleanup tasks (remove unused cache files) after the build - -h, --help help for server - --ignoreCache ignores the cache directory - -l, --layoutDir string filesystem path to layout directory - --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.) - --navigateToChanged navigate to changed content file on live browser reload - --noBuildLock don't create .hugo_build.lock file - --noChmod don't sync permission mode of files - --noHTTPCache prevent HTTP caching - --noTimes don't sync modification time of files - --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 - -p, --port int port on which the server will listen (default 1313) - --printI18nWarnings print missing translations - --printMemoryUsage print memory usage to screen at intervals - --printPathWarnings print warnings on duplicate target paths etc. - --printUnusedTemplates print warnings on unused templates. - --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 - --templateMetricsHints calculate some improvement hints when combined with --templateMetrics - -t, --theme strings themes to use (located in /themes/THEMENAME/) - --trace file write trace to file (not useful in general) - -w, --watch watch filesystem for changes and recreate as needed (default true) -``` - -### Options inherited from parent commands - -``` + --appendPort append port to baseURL (default true) + -b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/ + --bind string interface to which the server will bind (default "127.0.0.1") + -D, --buildDrafts include content marked as draft + -E, --buildExpired include expired content + -F, --buildFuture include content with publishdate in the future + --cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ + --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 - --config string config file (default is path/config.yaml|json|toml) - --configDir string config dir (default "config") - --debug debug output + -c, --contentDir string filesystem path to content directory + -d, --destination string filesystem path to write files to + --disableBrowserError do not show build errors in the browser + --disableFastRender enables full re-renders on changes + --disableKinds strings disable different kind of pages (home, RSS etc.) + --disableLiveReload watch without enabling live browser reload on rebuild + --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. + --gc enable to run some cleanup tasks (remove unused cache files) after the build + -h, --help help for server + --ignoreCache ignores the cache directory |