diff --git a/content/en/commands/hugo.md b/content/en/commands/hugo.md index 0b42d5521..73d443169 100644 --- a/content/en/commands/hugo.md +++ b/content/en/commands/hugo.md @@ -82,5 +82,5 @@ hugo [flags] * [hugo mod](/commands/hugo_mod/) - Various Hugo Modules helpers. * [hugo new](/commands/hugo_new/) - Create new content for your site * [hugo server](/commands/hugo_server/) - A high performance webserver -* [hugo version](/commands/hugo_version/) - Print the version number of Hugo +* [hugo version](/commands/hugo_version/) - Print Hugo version and environment info diff --git a/content/en/commands/hugo_completion.md b/content/en/commands/hugo_completion.md index 5387f7aed..d7cc64cc2 100644 --- a/content/en/commands/hugo_completion.md +++ b/content/en/commands/hugo_completion.md @@ -26,6 +26,7 @@ See each sub-command's help for details on how to use the generated script. --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/content/en/commands/hugo_completion_bash.md b/content/en/commands/hugo_completion_bash.md index 22d948647..eb6fdd8d4 100644 --- a/content/en/commands/hugo_completion_bash.md +++ b/content/en/commands/hugo_completion_bash.md @@ -49,6 +49,7 @@ hugo completion bash --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/content/en/commands/hugo_completion_fish.md b/content/en/commands/hugo_completion_fish.md index 481507044..f81acb8af 100644 --- a/content/en/commands/hugo_completion_fish.md +++ b/content/en/commands/hugo_completion_fish.md @@ -40,6 +40,7 @@ hugo completion fish [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/content/en/commands/hugo_completion_powershell.md b/content/en/commands/hugo_completion_powershell.md index 7e6abb9f4..5f900ec59 100644 --- a/content/en/commands/hugo_completion_powershell.md +++ b/content/en/commands/hugo_completion_powershell.md @@ -37,6 +37,7 @@ hugo completion powershell [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/content/en/commands/hugo_completion_zsh.md b/content/en/commands/hugo_completion_zsh.md index 9612817e3..fbe5c6ad4 100644 --- a/content/en/commands/hugo_completion_zsh.md +++ b/content/en/commands/hugo_completion_zsh.md @@ -18,7 +18,7 @@ to enable it. You can execute the following once: To load completions in your current shell session: - source <(hugo completion zsh); compdef _hugo hugo + source <(hugo completion zsh) To load completions for every new session, execute once: @@ -51,6 +51,7 @@ hugo completion zsh [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/content/en/commands/hugo_config.md b/content/en/commands/hugo_config.md index ca73bbe4b..775646576 100644 --- a/content/en/commands/hugo_config.md +++ b/content/en/commands/hugo_config.md @@ -12,31 +12,32 @@ Print the site configuration Print the site configuration, both default and custom settings. ``` -hugo config [flags] +hugo config [command] [flags] ``` ### 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 - --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 + -h, --help help for config ``` ### Options inherited from parent commands ``` - --config string config file (default is hugo.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 + --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 hugo.yaml|json|toml) + --configDir string config dir (default "config") + --debug debug output + -d, --destination string filesystem path to write files to + -e, --environment string build environment + --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 ``` ### SEE ALSO diff --git a/content/en/commands/hugo_config_mounts.md b/content/en/commands/hugo_config_mounts.md index 825ddf1b5..9ec0a5e7f 100644 --- a/content/en/commands/hugo_config_mounts.md +++ b/content/en/commands/hugo_config_mounts.md @@ -8,7 +8,7 @@ url: /commands/hugo_config_mounts/ Print the configured file mounts ``` -hugo config mounts [flags] +hugo config mounts [flags] [args] ``` ### Options @@ -24,6 +24,7 @@ hugo config mounts [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/content/en/commands/hugo_convert.md b/content/en/commands/hugo_convert.md index e8015a5b5..c52433487 100644 --- a/content/en/commands/hugo_convert.md +++ b/content/en/commands/hugo_convert.md @@ -13,30 +13,35 @@ Convert your content (e.g. front matter) to different formats. See convert's subcommands toJSON, toTOML and toYAML for more information. +``` +hugo convert [command] [flags] +``` + ### 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 - --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern - -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 + -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 ``` - --config string config file (default is hugo.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 + --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 hugo.yaml|json|toml) + --configDir string config dir (default "config") + --debug debug output + -d, --destination string filesystem path to write files to + -e, --environment string build environment + --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 ``` ### SEE ALSO diff --git a/content/en/commands/hugo_convert_toJSON.md b/content/en/commands/hugo_convert_toJSON.md index 162c42d0a..4b811f49e 100644 --- a/content/en/commands/hugo_convert_toJSON.md +++ b/content/en/commands/hugo_convert_toJSON.md @@ -13,7 +13,7 @@ toJSON converts all front matter in the content directory to use JSON for the front matter. ``` -hugo convert toJSON [flags] +hugo convert toJSON [flags] [args] ``` ### Options @@ -29,6 +29,7 @@ hugo convert toJSON [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/content/en/commands/hugo_convert_toTOML.md b/content/en/commands/hugo_convert_toTOML.md index 50c0c9ebf..19d847e90 100644 --- a/content/en/commands/hugo_convert_toTOML.md +++ b/content/en/commands/hugo_convert_toTOML.md @@ -13,7 +13,7 @@ toTOML converts all front matter in the content directory to use TOML for the front matter. ``` -hugo convert toTOML [flags] +hugo convert toTOML [flags] [args] ``` ### Options @@ -29,6 +29,7 @@ hugo convert toTOML [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/content/en/commands/hugo_convert_toYAML.md b/content/en/commands/hugo_convert_toYAML.md index bf2d28421..1785d3ad8 100644 --- a/content/en/commands/hugo_convert_toYAML.md +++ b/content/en/commands/hugo_convert_toYAML.md @@ -13,7 +13,7 @@ toYAML converts all front matter in the content directory to use YAML for the front matter. ``` -hugo convert toYAML [flags] +hugo convert toYAML [flags] [args] ``` ### Options @@ -29,6 +29,7 @@ hugo convert toYAML [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/content/en/commands/hugo_deploy.md b/content/en/commands/hugo_deploy.md index 7b14c30ef..4bec6df50 100644 --- a/content/en/commands/hugo_deploy.md +++ b/content/en/commands/hugo_deploy.md @@ -16,38 +16,39 @@ documentation. ``` -hugo deploy [flags] +hugo deploy [flags] [args] ``` ### 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 - --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 - --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) - --workers int number of workers to transfer files. (default 10) - -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 + --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 + --workers int number of workers to transfer files. defaults to 10 (default 10) ``` ### Options inherited from parent commands ``` - --config string config file (default is hugo.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 + --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 hugo.yaml|json|toml) + --configDir string config dir (default "config") + --debug debug output + -d, --destination string filesystem path to write files to + -e, --environment string build environment + --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 ``` ### SEE ALSO diff --git a/content/en/commands/hugo_env.md b/content/en/commands/hugo_env.md index 632614d50..296e6e002 100644 --- a/content/en/commands/hugo_env.md +++ b/content/en/commands/hugo_env.md @@ -9,13 +9,10 @@ Print Hugo version and environment info ### Synopsis -Print Hugo version and environment info. This is useful in Hugo bug reports. - -If you add the -v flag, you will get a full dependency list. - +Print Hugo version and environment info. This is useful in Hugo bug reports ``` -hugo env [flags] +hugo env [flags] [args] ``` ### Options @@ -31,6 +28,7 @@ hugo env [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/content/en/commands/hugo_gen.md b/content/en/commands/hugo_gen.md index 281669b59..71c6dfe42 100644 --- a/content/en/commands/hugo_gen.md +++ b/content/en/commands/hugo_gen.md @@ -7,6 +7,10 @@ url: /commands/hugo_gen/ A collection of several useful generators. +``` +hugo gen [command] [flags] +``` + ### Options ``` @@ -20,6 +24,7 @@ A collection of several useful generators. --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/content/en/commands/hugo_gen_chromastyles.md b/content/en/commands/hugo_gen_chromastyles.md index ed434b1c7..9c41f7174 100644 --- a/content/en/commands/hugo_gen_chromastyles.md +++ b/content/en/commands/hugo_gen_chromastyles.md @@ -14,7 +14,7 @@ Generate CSS stylesheet for the Chroma code highlighter for a given style. This See https://xyproto.github.io/splash/docs/all.html for a preview of the available styles ``` -hugo gen chromastyles [flags] +hugo gen chromastyles [flags] [args] ``` ### Options @@ -33,6 +33,7 @@ hugo gen chromastyles [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/content/en/commands/hugo_gen_doc.md b/content/en/commands/hugo_gen_doc.md index b6e6a99f2..59999fb7b 100644 --- a/content/en/commands/hugo_gen_doc.md +++ b/content/en/commands/hugo_gen_doc.md @@ -10,15 +10,14 @@ Generate Markdown documentation for the Hugo CLI. ### Synopsis 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. + 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. ``` -hugo gen doc [flags] +hugo gen doc [flags] [args] ``` ### Options @@ -35,6 +34,7 @@ hugo gen doc [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/content/en/commands/hugo_gen_man.md b/content/en/commands/hugo_gen_man.md index c37ca2420..f2c40d71d 100644 --- a/content/en/commands/hugo_gen_man.md +++ b/content/en/commands/hugo_gen_man.md @@ -10,11 +10,11 @@ Generate man pages for the Hugo CLI ### Synopsis This command automatically generates up-to-date man pages of Hugo's -command-line interface. By default, it creates the man page files -in the "man" directory under the current directory. + command-line interface. By default, it creates the man page files + in the "man" directory under the current directory. ``` -hugo gen man [flags] +hugo gen man [flags] [args] ``` ### Options @@ -31,6 +31,7 @@ hugo gen man [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/content/en/commands/hugo_import.md b/content/en/commands/hugo_import.md index 70b182902..c9774f466 100644 --- a/content/en/commands/hugo_import.md +++ b/content/en/commands/hugo_import.md @@ -13,6 +13,10 @@ Import your site from other web site generators like Jekyll. Import requires a subcommand, e.g. `hugo import jekyll jekyll_root_path target_path`. +``` +hugo import [command] [flags] +``` + ### Options ``` @@ -26,6 +30,7 @@ Import requires a subcommand, e.g. `hugo import jekyll jekyll_root_path target_p --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/content/en/commands/hugo_import_jekyll.md b/content/en/commands/hugo_import_jekyll.md index ff0ff549b..4e4876d90 100644 --- a/content/en/commands/hugo_import_jekyll.md +++ b/content/en/commands/hugo_import_jekyll.md @@ -10,11 +10,11 @@ hugo import from Jekyll ### Synopsis hugo import from Jekyll. - + Import from Jekyll requires two paths, e.g. `hugo import jekyll jekyll_root_path target_path`. ``` -hugo import jekyll [flags] +hugo import jekyll [flags] [args] ``` ### Options @@ -31,6 +31,7 @@ hugo import jekyll [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/content/en/commands/hugo_list.md b/content/en/commands/hugo_list.md index e2854c568..6a3ec36d8 100644 --- a/content/en/commands/hugo_list.md +++ b/content/en/commands/hugo_list.md @@ -11,30 +11,35 @@ Listing out various types of content Listing out various types of content. -List requires a subcommand, e.g. `hugo list drafts`. +List requires a subcommand, e.g. hugo list drafts + +``` +hugo list [command] [flags] +``` ### 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 - --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 + -h, --help help for list ``` ### Options inherited from parent commands ``` - --config string config file (default is hugo.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 + --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 hugo.yaml|json|toml) + --configDir string config dir (default "config") + --debug debug output + -d, --destination string filesystem path to write files to + -e, --environment string build environment + --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 ``` ### SEE ALSO diff --git a/content/en/commands/hugo_list_all.md b/content/en/commands/hugo_list_all.md index a6f9f94d6..5ac8a7c35 100644 --- a/content/en/commands/hugo_list_all.md +++ b/content/en/commands/hugo_list_all.md @@ -12,7 +12,7 @@ List all posts List all of the posts in your content directory, include drafts, future and expired pages. ``` -hugo list all [flags] +hugo list all [flags] [args] ``` ### Options @@ -28,6 +28,7 @@ hugo list all [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/content/en/commands/hugo_list_drafts.md b/content/en/commands/hugo_list_drafts.md index 98c8a047c..601c7648f 100644 --- a/content/en/commands/hugo_list_drafts.md +++ b/content/en/commands/hugo_list_drafts.md @@ -12,7 +12,7 @@ List all drafts List all of the drafts in your content directory. ``` -hugo list drafts [flags] +hugo list drafts [flags] [args] ``` ### Options @@ -28,6 +28,7 @@ hugo list drafts [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/content/en/commands/hugo_list_expired.md b/content/en/commands/hugo_list_expired.md index 89c10d501..47a9cc369 100644 --- a/content/en/commands/hugo_list_expired.md +++ b/content/en/commands/hugo_list_expired.md @@ -12,7 +12,7 @@ List all posts already expired List all of the posts in your content directory which has already expired. ``` -hugo list expired [flags] +hugo list expired [flags] [args] ``` ### Options @@ -28,6 +28,7 @@ hugo list expired [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/content/en/commands/hugo_list_future.md b/content/en/commands/hugo_list_future.md index ca15b7673..5cbb86c74 100644 --- a/content/en/commands/hugo_list_future.md +++ b/content/en/commands/hugo_list_future.md @@ -12,7 +12,7 @@ List all posts dated in the future List all of the posts in your content directory which will be posted in the future. ``` -hugo list future [flags] +hugo list future [flags] [args] ``` ### Options @@ -28,6 +28,7 @@ hugo list future [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/content/en/commands/hugo_mod.md b/content/en/commands/hugo_mod.md index 1df6df78e..ac7e16f25 100644 --- a/content/en/commands/hugo_mod.md +++ b/content/en/commands/hugo_mod.md @@ -10,7 +10,6 @@ Various Hugo Modules helpers. ### Synopsis Various helpers to help manage the modules in your project's dependency graph. - Most operations here requires a Go version installed on your system (>= Go 1.12) and the relevant VCS client (typically Git). This is not needed if you only operate on modules inside /themes or if you have vendored them via "hugo mod vendor". @@ -26,53 +25,26 @@ 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 - --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 - -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 - -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 - --trace file write trace to file (not useful in general) + -h, --help help for mod ``` ### Options inherited from parent commands ``` - --config string config file (default is hugo.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 + --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 hugo.yaml|json|toml) + --configDir string config dir (default "config") + --debug debug output + -d, --destination string filesystem path to write files to + -e, --environment string build environment + --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 ``` ### SEE ALSO diff --git a/content/en/commands/hugo_mod_clean.md b/content/en/commands/hugo_mod_clean.md index b13b7c020..ad97610cd 100644 --- a/content/en/commands/hugo_mod_clean.md +++ b/content/en/commands/hugo_mod_clean.md @@ -11,14 +11,8 @@ Delete the Hugo Module cache for the current project. Delete the Hugo Module cache for the current project. -Note that after you run this command, all of your dependencies will be re-downloaded next time you run "hugo". - -Also note that if you configure a positive maxAge for the "modules" file cache, it will also be cleaned as part of "hugo --gc". - - - ``` -hugo mod clean [flags] +hugo mod clean [flags] [args] ``` ### Options @@ -36,6 +30,7 @@ hugo mod clean [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/content/en/commands/hugo_mod_get.md b/content/en/commands/hugo_mod_get.md index 54eaa74de..21fa1f967 100644 --- a/content/en/commands/hugo_mod_get.md +++ b/content/en/commands/hugo_mod_get.md @@ -38,7 +38,7 @@ See https://gohugo.io/hugo-modules/ for more information. ``` -hugo mod get [flags] +hugo mod get [flags] [args] ``` ### Options @@ -54,6 +54,7 @@ hugo mod get [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/content/en/commands/hugo_mod_graph.md b/content/en/commands/hugo_mod_graph.md index ba8898a69..79ff3170f 100644 --- a/content/en/commands/hugo_mod_graph.md +++ b/content/en/commands/hugo_mod_graph.md @@ -14,13 +14,14 @@ Note that for vendored modules, that is the version listed and not the one from ``` -hugo mod graph [flags] +hugo mod graph [flags] [args] ``` ### Options ``` - -h, --help help for graph + --clean delete module cache for dependencies that fail verification + -h, --help help for graph ``` ### Options inherited from parent commands @@ -30,6 +31,7 @@ hugo mod graph [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/content/en/commands/hugo_mod_init.md b/content/en/commands/hugo_mod_init.md index 21aacf131..ad4501b64 100644 --- a/content/en/commands/hugo_mod_init.md +++ b/content/en/commands/hugo_mod_init.md @@ -10,16 +10,16 @@ Initialize this project as a Hugo Module. ### Synopsis Initialize this project as a Hugo Module. -It will try to guess the module path, but you may help by passing it as an argument, e.g: - - hugo mod init github.com/gohugoio/testshortcodes - -Note that Hugo Modules supports multi-module projects, so you can initialize a Hugo Module -inside a subfolder on GitHub, as one example. - + It will try to guess the module path, but you may help by passing it as an argument, e.g: + + hugo mod init github.com/gohugoio/testshortcodes + + Note that Hugo Modules supports multi-module projects, so you can initialize a Hugo Module + inside a subfolder on GitHub, as one example. + ``` -hugo mod init [flags] +hugo mod init [flags] [args] ``` ### Options @@ -35,6 +35,7 @@ hugo mod init [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/content/en/commands/hugo_mod_npm.md b/content/en/commands/hugo_mod_npm.md index 0a9a43869..8e13a7294 100644 --- a/content/en/commands/hugo_mod_npm.md +++ b/content/en/commands/hugo_mod_npm.md @@ -12,7 +12,7 @@ Various npm helpers. Various npm (Node package manager) helpers. ``` -hugo mod npm [flags] +hugo mod npm [command] [flags] ``` ### Options @@ -28,6 +28,7 @@ hugo mod npm [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/content/en/commands/hugo_mod_npm_pack.md b/content/en/commands/hugo_mod_npm_pack.md index 597b039de..aadac772b 100644 --- a/content/en/commands/hugo_mod_npm_pack.md +++ b/content/en/commands/hugo_mod_npm_pack.md @@ -22,7 +22,7 @@ so this may/will change in future versions of Hugo. ``` -hugo mod npm pack [flags] +hugo mod npm pack [flags] [args] ``` ### Options @@ -38,6 +38,7 @@ hugo mod npm pack [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/content/en/commands/hugo_mod_tidy.md b/content/en/commands/hugo_mod_tidy.md index 68279cf9b..9c665f1c5 100644 --- a/content/en/commands/hugo_mod_tidy.md +++ b/content/en/commands/hugo_mod_tidy.md @@ -8,7 +8,7 @@ url: /commands/hugo_mod_tidy/ Remove unused entries in go.mod and go.sum. ``` -hugo mod tidy [flags] +hugo mod tidy [flags] [args] ``` ### Options @@ -24,6 +24,7 @@ hugo mod tidy [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/content/en/commands/hugo_mod_vendor.md b/content/en/commands/hugo_mod_vendor.md index 1dab295ca..42c04609a 100644 --- a/content/en/commands/hugo_mod_vendor.md +++ b/content/en/commands/hugo_mod_vendor.md @@ -10,12 +10,11 @@ Vendor all module dependencies into the _vendor directory. ### Synopsis Vendor all module dependencies into the _vendor directory. - -If a module is vendored, that is where Hugo will look for it's dependencies. - + If a module is vendored, that is where Hugo will look for it's dependencies. + ``` -hugo mod vendor [flags] +hugo mod vendor [flags] [args] ``` ### Options @@ -31,6 +30,7 @@ hugo mod vendor [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/content/en/commands/hugo_mod_verify.md b/content/en/commands/hugo_mod_verify.md index 7ffab453e..9cddcbc25 100644 --- a/content/en/commands/hugo_mod_verify.md +++ b/content/en/commands/hugo_mod_verify.md @@ -11,9 +11,8 @@ Verify dependencies. Verify checks that the dependencies of the current module, which are stored in a local downloaded source cache, have not been modified since being downloaded. - ``` -hugo mod verify [flags] +hugo mod verify [flags] [args] ``` ### Options @@ -30,6 +29,7 @@ hugo mod verify [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/content/en/commands/hugo_new.md b/content/en/commands/hugo_new.md index e0f58247b..31d6f1f18 100644 --- a/content/en/commands/hugo_new.md +++ b/content/en/commands/hugo_new.md @@ -19,67 +19,38 @@ If archetypes are provided in your theme or site, they will be used. Ensure you run this within the root directory of your site. ``` -hugo new [path] [flags] +hugo new [command] [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 - --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 - -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 - -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 - --trace file write trace to file (not useful in general) + -h, --help help for new ``` ### Options inherited from parent commands ``` - --config string config file (default is hugo.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 + --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 hugo.yaml|json|toml) + --configDir string config dir (default "config") + --debug debug output + -d, --destination string filesystem path to write files to + -e, --environment string build environment + --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 ``` ### SEE ALSO * [hugo](/commands/hugo/) - hugo builds your site +* [hugo new content](/commands/hugo_new_content/) - Create new content for your site * [hugo new site](/commands/hugo_new_site/) - Create a new site (skeleton) -* [hugo new theme](/commands/hugo_new_theme/) - Create a new theme +* [hugo new theme](/commands/hugo_new_theme/) - Create a new site (skeleton) diff --git a/content/en/commands/hugo_new_content.md b/content/en/commands/hugo_new_content.md new file mode 100644 index 000000000..5ff63a20b --- /dev/null +++ b/content/en/commands/hugo_new_content.md @@ -0,0 +1,56 @@ +--- +title: "hugo new content" +slug: hugo_new_content +url: /commands/hugo_new_content/ +--- +## hugo new content + +Create new content for your site + +### Synopsis + +Create a new content file and automatically set the date and title. + It will guess which kind of file to create based on the path provided. + + You can also specify the kind with `-k KIND`. + + If archetypes are provided in your theme or site, they will be used. + + Ensure you run this within the root directory of your site. + +``` +hugo new content [path] [flags] +``` + +### Options + +``` + --editor string edit new content with this editor, if provided + -f, --force overwrite file if it already exists + -h, --help help for content + -k, --kind string content type to create +``` + +### 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 hugo.yaml|json|toml) + --configDir string config dir (default "config") + --debug debug output + -d, --destination string filesystem path to write files to + -e, --environment string build environment + --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 +``` + +### SEE ALSO + +* [hugo new](/commands/hugo_new/) - Create new content for your site + diff --git a/content/en/commands/hugo_new_site.md b/content/en/commands/hugo_new_site.md index e594a9979..96bb51924 100644 --- a/content/en/commands/hugo_new_site.md +++ b/content/en/commands/hugo_new_site.md @@ -20,27 +20,28 @@ hugo new site [path] [flags] ### 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 - -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 - -s, --source string filesystem path to read files relative from - --themesDir string filesystem path to themes directory + --force init inside non-empty directory + -f, --format string config file format (default "toml") + -h, --help help for site ``` ### Options inherited from parent commands ``` - --config string config file (default is hugo.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 + --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 hugo.yaml|json|toml) + --configDir string config dir (default "config") + --debug debug output + -d, --destination string filesystem path to write files to + -e, --environment string build environment + --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 ``` ### SEE ALSO diff --git a/content/en/commands/hugo_new_theme.md b/content/en/commands/hugo_new_theme.md index 48c374d98..a4057e0f1 100644 --- a/content/en/commands/hugo_new_theme.md +++ b/content/en/commands/hugo_new_theme.md @@ -5,41 +5,41 @@ url: /commands/hugo_new_theme/ --- ## hugo new theme -Create a new theme +Create a new site (skeleton) ### Synopsis -Create a new theme (skeleton) called [name] in ./themes. -New theme is a skeleton. Please add content to the touched files. Add your -name to the copyright line in the license and adjust the theme.toml file -as you see fit. +Create a new site in the provided directory. +The new site will have the correct structure, but no content or theme yet. +Use `hugo new [contentPath]` to create new content. ``` -hugo new theme [name] [flags] +hugo new theme [path] [flags] ``` ### 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 - --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 + -h, --help help for theme ``` ### Options inherited from parent commands ``` - --config string config file (default is hugo.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 + --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 hugo.yaml|json|toml) + --configDir string config dir (default "config") + --debug debug output + -d, --destination string filesystem path to write files to + -e, --environment string build environment + --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 ``` ### SEE ALSO diff --git a/content/en/commands/hugo_server.md b/content/en/commands/hugo_server.md index f80bd496e..27e12deb9 100644 --- a/content/en/commands/hugo_server.md +++ b/content/en/commands/hugo_server.md @@ -23,73 +23,73 @@ and push the latest content to them. As most Hugo sites are built in a fraction of a second, you will be able to save and see your changes nearly instantly. ``` -hugo server [flags] +hugo server [flags] [args] ``` ### 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 - --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 - -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 - --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern - -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) - -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 - --trace file write trace to file (not useful in general) - -w, --watch watch filesystem for changes and recreate as needed (default true) + --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 + --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 ``` - --config string config file (default is hugo.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 + --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 hugo.yaml|json|toml) + --configDir string config dir (default "config") + --debug debug output + -d, --destination string filesystem path to write files to + -e, --environment string build environment + --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 ``` ### SEE ALSO diff --git a/content/en/commands/hugo_version.md b/content/en/commands/hugo_version.md index bdef5bbd4..b78237bb7 100644 --- a/content/en/commands/hugo_version.md +++ b/content/en/commands/hugo_version.md @@ -5,14 +5,14 @@ url: /commands/hugo_version/ --- ## hugo version -Print the version number of Hugo +Print Hugo version and environment info ### Synopsis -All software has versions. This is Hugo's. +Print Hugo version and environment info. This is useful in Hugo bug reports. ``` -hugo version [flags] +hugo version [flags] [args] ``` ### Options @@ -28,6 +28,7 @@ hugo version [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/content/en/content-management/shortcodes.md b/content/en/content-management/shortcodes.md index f91adc227..35ffc390f 100644 --- a/content/en/content-management/shortcodes.md +++ b/content/en/content-management/shortcodes.md @@ -116,6 +116,9 @@ height width : `width` attribute of the image. +loading +: `loading` attribute of the image. + attr : Image attribution text. Markdown within the value of `attr` will be rendered. diff --git a/content/en/functions/hasPrefix.md b/content/en/functions/hasPrefix.md new file mode 100644 index 000000000..cf29315e2 --- /dev/null +++ b/content/en/functions/hasPrefix.md @@ -0,0 +1,21 @@ +--- +title: hasprefix +linktitle: hasPrefix +description: Tests whether a string begins with prefix. +date: 2017-02-01 +publishdate: 2017-02-01 +lastmod: 2017-02-01 +categories: [functions] +menu: + docs: + parent: "functions" +keywords: [strings] +signature: ["hasPrefix STRING PREFIX"] +workson: [] +hugoversion: +relatedfuncs: [hasSuffix] +deprecated: false +aliases: [] +--- + +* `{{ hasPrefix "Hugo" "Hu" }}` → true diff --git a/content/en/functions/hasSuffix.md b/content/en/functions/hasSuffix.md new file mode 100644 index 000000000..9906cc2c3 --- /dev/null +++ b/content/en/functions/hasSuffix.md @@ -0,0 +1,21 @@ +--- +title: hassuffix +linktitle: hasSuffix +description: Tests whether a string ends with suffix. +date: 2023-03-01 +publishdate: 2023-03-01 +lastmod: 2023-03-01 +categories: [functions] +menu: +docs: +parent: "functions" +keywords: [strings] +signature: ["hasSuffix STRING SUFFIX"] +workson: [] +hugoversion: +relatedfuncs: [hasPrefix] +deprecated: false +aliases: [] +--- + +* `{{ hasSuffix "Hugo" "go" }}` → true \ No newline at end of file diff --git a/content/en/functions/math.md b/content/en/functions/math.md index e84bb5f1f..c36b8ea0b 100644 --- a/content/en/functions/math.md +++ b/content/en/functions/math.md @@ -23,6 +23,7 @@ relatedfuncs: [] | | *If one of the numbers is a float, the result is a float.* | `{{ div 6 4.0 }}` → `1.5` | | `mod` | Modulus of two integers. | `{{ mod 15 3 }}` → `0` | | `modBool` | Boolean of modulus of two integers. Evaluates to `true` if result equals 0. | `{{ modBool 15 3 }}` → `true` | +| `math.Abs` | Returns the absolute value of the given number. | `{{ math.Abs -2.1 }}` → `2.1` | | `math.Ceil` | Returns the least integer value greater than or equal to the given number. | `{{ math.Ceil 2.1 }}` → `3` | | `math.Floor` | Returns the greatest integer value less than or equal to the given number. | `{{ math.Floor 1.9 }}` → `1` | | `math.Log` | Returns the natural logarithm of the given number. | `{{ math.Log 42 }}` → `3.737` | diff --git a/content/en/functions/urls.JoinPath.md b/content/en/functions/urls.JoinPath.md new file mode 100644 index 000000000..f11632367 --- /dev/null +++ b/content/en/functions/urls.JoinPath.md @@ -0,0 +1,25 @@ +--- +title: urls.JoinPath +description: Joins the provided elements into a URL string and cleans the result of any ./ or ../ elements. If the argument list is empty, JoinPath returns an empty string. +categories: [functions] +menu: + docs: + parent: functions +keywords: [urls,path,join] +signature: ["urls.JoinPath ELEMENT..."] +--- + +```go-html-template +{{ urls.JoinPath }} → "" +{{ urls.JoinPath "" }} → "/" +{{ urls.JoinPath "a" }} → "a" +{{ urls.JoinPath "a" "b" }} → "a/b" +{{ urls.JoinPath "/a" "b" }} → "/a/b" +{{ urls.JoinPath "https://example.org" "b" }} → "https://example.org/b" + +{{ urls.JoinPath (slice "a" "b") }} → "a/b" +``` + +Unlike the [`path.Join`] function, `urls.JoinPath` retains consecutive leading slashes. + +[`path.Join`]: /functions/path.join/ diff --git a/data/docs.json b/data/docs.json index 6efb03f8f..d75c35730 100644 --- a/data/docs.json +++ b/data/docs.json @@ -614,6 +614,12 @@ "hlsl" ] }, + { + "Name": "HolyC", + "Aliases": [ + "holyc" + ] + }, { "Name": "HTML", "Aliases": [ @@ -837,6 +843,12 @@ "nasm" ] }, + { + "Name": "Natural", + "Aliases": [ + "natural" + ] + }, { "Name": "Newspeak", "Aliases": [ @@ -1523,6 +1535,12 @@ "yang" ] }, + { + "Name": "Z80 Assembly", + "Aliases": [ + "z80" + ] + }, { "Name": "Zed", "Aliases": [ @@ -1576,7 +1594,19 @@ "wrapStandAloneImageWithinParagraph": true }, "extensions": { - "typographer": true, + "typographer": { + "disable": false, + "leftSingleQuote": "\u0026lsquo;", + "rightSingleQuote": "\u0026rsquo;", + "leftDoubleQuote": "\u0026ldquo;", + "rightDoubleQuote": "\u0026rdquo;", + "enDash": "\u0026ndash;", + "emDash": "\u0026mdash;", + "ellipsis": "\u0026hellip;", + "leftAngleQuote": "\u0026laquo;", + "rightAngleQuote": "\u0026raquo;", + "apostrophe": "\u0026rsquo;" + }, "footnote": true, "definitionList": true, "table": true, @@ -1693,7 +1723,8 @@ "js": { "precision": 0, "keepVarNames": false, - "noNullishOperator": false + "noNullishOperator": false, + "version": 0 }, "json": { "precision": 0, @@ -1728,6 +1759,7 @@ ] }, "http": { + "mediaTypes": null, "methods": [ "(?i)GET|POST" ], @@ -1743,10 +1775,6 @@ "mainType": "application", "subType": "json", "delimiter": ".", - "firstSuffix": { - "suffix": "json", - "fullSuffix": ".json" - }, "type": "application/json", "string": "application/json", "suffixes": [ @@ -1757,10 +1785,6 @@ "mainType": "application", "subType": "manifest", "delimiter": ".", - "firstSuffix": { - "suffix": "webmanifest", - "fullSuffix": ".webmanifest" - }, "type": "application/manifest+json", "string": "application/manifest+json", "suffixes": [ @@ -1771,10 +1795,6 @@ "mainType": "application", "subType": "octet-stream", "delimiter": ".", - "firstSuffix": { - "suffix": "", - "fullSuffix": "" - }, "type": "application/octet-stream", "string": "application/octet-stream", "suffixes": [ @@ -1785,10 +1805,6 @@ "mainType": "application", "subType": "pdf", "delimiter": ".", - "firstSuffix": { - "suffix": "pdf", - "fullSuffix": ".pdf" - }, "type": "application/pdf", "string": "application/pdf", "suffixes": [ @@ -1799,10 +1815,6 @@ "mainType": "application", "subType": "rss", "delimiter": ".", - "firstSuffix": { - "suffix": "xml", - "fullSuffix": ".xml" - }, "type": "application/rss+xml", "string": "application/rss+xml", "suffixes": [ @@ -1814,24 +1826,26 @@ "mainType": "application", "subType": "toml", "delimiter": ".", - "firstSuffix": { - "suffix": "toml", - "fullSuffix": ".toml" - }, "type": "application/toml", "string": "application/toml", "suffixes": [ "toml" ] }, + { + "mainType": "application", + "subType": "wasm", + "delimiter": ".", + "type": "application/wasm", + "string": "application/wasm", + "suffixes": [ + "wasm" + ] + }, { "mainType": "application", "subType": "xml", "delimiter": ".", - "firstSuffix": { - "suffix": "xml", - "fullSuffix": ".xml" - }, "type": "application/xml", "string": "application/xml", "suffixes": [ @@ -1842,10 +1856,6 @@ "mainType": "application", "subType": "yaml", "delimiter": ".", - "firstSuffix": { - "suffix": "yaml", - "fullSuffix": ".yaml" - }, "type": "application/yaml", "string": "application/yaml", "suffixes": [ @@ -1857,10 +1867,6 @@ "mainType": "font", "subType": "otf", "delimiter": ".", - "firstSuffix": { - "suffix": "otf", - "fullSuffix": ".otf" - }, "type": "font/otf", "string": "font/otf", "suffixes": [ @@ -1871,10 +1877,6 @@ "mainType": "font", "subType": "ttf", "delimiter": ".", - "firstSuffix": { - "suffix": "ttf", - "fullSuffix": ".ttf" - }, "type": "font/ttf", "string": "font/ttf", "suffixes": [ @@ -1885,10 +1887,6 @@ "mainType": "image", "subType": "bmp", "delimiter": ".", - "firstSuffix": { - "suffix": "bmp", - "fullSuffix": ".bmp" - }, "type": "image/bmp", "string": "image/bmp", "suffixes": [ @@ -1899,10 +1897,6 @@ "mainType": "image", "subType": "gif", "delimiter": ".", - "firstSuffix": { - "suffix": "gif", - "fullSuffix": ".gif" - }, "type": "image/gif", "string": "image/gif", "suffixes": [ @@ -1913,10 +1907,6 @@ "mainType": "image", "subType": "jpeg", "delimiter": ".", - "firstSuffix": { - "suffix": "jpg", - "fullSuffix": ".jpg" - }, "type": "image/jpeg", "string": "image/jpeg", "suffixes": [ @@ -1931,10 +1921,6 @@ "mainType": "image", "subType": "png", "delimiter": ".", - "firstSuffix": { - "suffix": "png", - "fullSuffix": ".png" - }, "type": "image/png", "string": "image/png", "suffixes": [ @@ -1945,24 +1931,27 @@ "mainType": "image", "subType": "svg", "delimiter": ".", - "firstSuffix": { - "suffix": "svg", - "fullSuffix": ".svg" - }, "type": "image/svg+xml", "string": "image/svg+xml", "suffixes": [ "svg" ] }, + { + "mainType": "image", + "subType": "tiff", + "delimiter": ".", + "type": "image/tiff", + "string": "image/tiff", + "suffixes": [ + "tif", + "tiff" + ] + }, { "mainType": "image", "subType": "webp", "delimiter": ".", - "firstSuffix": { - "suffix": "webp", - "fullSuffix": ".webp" - }, "type": "image/webp", "string": "image/webp", "suffixes": [ @@ -1973,10 +1962,6 @@ "mainType": "text", "subType": "calendar", "delimiter": ".", - "firstSuffix": { - "suffix": "ics", - "fullSuffix": ".ics" - }, "type": "text/calendar", "string": "text/calendar", "suffixes": [ @@ -1987,10 +1972,6 @@ "mainType": "text", "subType": "css", "delimiter": ".", - "firstSuffix": { - "suffix": "css", - "fullSuffix": ".css" - }, "type": "text/css", "string": "text/css", "suffixes": [ @@ -2001,10 +1982,6 @@ "mainType": "text", "subType": "csv", "delimiter": ".", - "firstSuffix": { - "suffix": "csv", - "fullSuffix": ".csv" - }, "type": "text/csv", "string": "text/csv", "suffixes": [ @@ -2015,10 +1992,6 @@ "mainType": "text", "subType": "html", "delimiter": ".", - "firstSuffix": { - "suffix": "html", - "fullSuffix": ".html" - }, "type": "text/html", "string": "text/html", "suffixes": [ @@ -2029,10 +2002,6 @@ "mainType": "text", "subType": "javascript", "delimiter": ".", - "firstSuffix": { - "suffix": "js", - "fullSuffix": ".js" - }, "type": "text/javascript", "string": "text/javascript", "suffixes": [ @@ -2045,10 +2014,6 @@ "mainType": "text", "subType": "jsx", "delimiter": ".", - "firstSuffix": { - "suffix": "jsx", - "fullSuffix": ".jsx" - }, "type": "text/jsx", "string": "text/jsx", "suffixes": [ @@ -2059,10 +2024,6 @@ "mainType": "text", "subType": "markdown", "delimiter": ".", - "firstSuffix": { - "suffix": "md", - "fullSuffix": ".md" - }, "type": "text/markdown", "string": "text/markdown", "suffixes": [ @@ -2074,10 +2035,6 @@ "mainType": "text", "subType": "plain", "delimiter": ".", - "firstSuffix": { - "suffix": "txt", - "fullSuffix": ".txt" - }, "type": "text/plain", "string": "text/plain", "suffixes": [ @@ -2088,10 +2045,6 @@ "mainType": "text", "subType": "tsx", "delimiter": ".", - "firstSuffix": { - "suffix": "tsx", - "fullSuffix": ".tsx" - }, "type": "text/tsx", "string": "text/tsx", "suffixes": [ @@ -2102,10 +2055,6 @@ "mainType": "text", "subType": "typescript", "delimiter": ".", - "firstSuffix": { - "suffix": "ts", - "fullSuffix": ".ts" - }, "type": "text/typescript", "string": "text/typescript", "suffixes": [ @@ -2116,10 +2065,6 @@ "mainType": "text", "subType": "x-sass", "delimiter": ".", - "firstSuffix": { - "suffix": "sass", - "fullSuffix": ".sass" - }, "type": "text/x-sass", "string": "text/x-sass", "suffixes": [ @@ -2130,10 +2075,6 @@ "mainType": "text", "subType": "x-scss", "delimiter": ".", - "firstSuffix": { - "suffix": "scss", - "fullSuffix": ".scss" - }, "type": "text/x-scss", "string": "text/x-scss", "suffixes": [ @@ -2144,10 +2085,6 @@ "mainType": "video", "subType": "3gpp", "delimiter": ".", - "firstSuffix": { - "suffix": "3gpp", - "fullSuffix": ".3gpp" - }, "type": "video/3gpp", "string": "video/3gpp", "suffixes": [ @@ -2159,10 +2096,6 @@ "mainType": "video", "subType": "mp4", "delimiter": ".", - "firstSuffix": { - "suffix": "mp4", - "fullSuffix": ".mp4" - }, "type": "video/mp4", "string": "video/mp4", "suffixes": [ @@ -2173,10 +2106,6 @@ "mainType": "video", "subType": "mpeg", "delimiter": ".", - "firstSuffix": { - "suffix": "mpg", - "fullSuffix": ".mpg" - }, "type": "video/mpeg", "string": "video/mpeg", "suffixes": [ @@ -2188,10 +2117,6 @@ "mainType": "video", "subType": "ogg", "delimiter": ".", - "firstSuffix": { - "suffix": "ogv", - "fullSuffix": ".ogv" - }, "type": "video/ogg", "string": "video/ogg", "suffixes": [ @@ -2202,10 +2127,6 @@ "mainType": "video", "subType": "webm", "delimiter": ".", - "firstSuffix": { - "suffix": "webm", - "fullSuffix": ".webm" - }, "type": "video/webm", "string": "video/webm", "suffixes": [ @@ -2216,10 +2137,6 @@ "mainType": "video", "subType": "x-msvideo", "delimiter": ".", - "firstSuffix": { - "suffix": "avi", - "fullSuffix": ".avi" - }, "type": "video/x-msvideo", "string": "video/x-msvideo", "suffixes": [ @@ -2232,7 +2149,7 @@ "formats": [ { "mediaType": "text/html", - "name": "HTML", + "name": "html", "path": "", "baseName": "index", "rel": "canonical", @@ -2246,7 +2163,7 @@ }, { "mediaType": "text/html", - "name": "AMP", + "name": "amp", "path": "amp", "baseName": "index", "rel": "amphtml", @@ -2258,9 +2175,23 @@ "permalinkable": true, "weight": 0 }, + { + "mediaType": "text/calendar", + "name": "calendar", + "path": "", + "baseName": "index", + "rel": "alternate", + "protocol": "webcal://", + "isPlainText": true, + "isHTML": false, + "noUgly": false, + "notAlternative": false, + "permalinkable": false, + "weight": 0 + }, { "mediaType": "text/css", - "name": "CSS", + "name": "css", "path": "", "baseName": "styles", "rel": "stylesheet", @@ -2274,7 +2205,7 @@ }, { "mediaType": "text/csv", - "name": "CSV", + "name": "csv", "path": "", "baseName": "index", "rel": "alternate", @@ -2286,23 +2217,9 @@ "permalinkable": false, "weight": 0 }, - { - "mediaType": "text/calendar", - "name": "Calendar", - "path": "", - "baseName": "index", - "rel": "alternate", - "protocol": "webcal://", - "isPlainText": true, - "isHTML": false, - "noUgly": false, - "notAlternative": false, - "permalinkable": false, - "weight": 0 - }, { "mediaType": "application/json", - "name": "JSON", + "name": "json", "path": "", "baseName": "index", "rel": "alternate", @@ -2316,7 +2233,7 @@ }, { "mediaType": "text/markdown", - "name": "MARKDOWN", + "name": "markdown", "path": "", "baseName": "index", "rel": "alternate", @@ -2330,7 +2247,7 @@ }, { "mediaType": "text/plain", - "name": "ROBOTS", + "name": "robots", "path": "", "baseName": "robots", "rel": "alternate", @@ -2344,7 +2261,7 @@ }, { "mediaType": "application/rss+xml", - "name": "RSS", + "name": "rss", "path": "", "baseName": "index", "rel": "alternate", @@ -2358,7 +2275,7 @@ }, { "mediaType": "application/xml", - "name": "Sitemap", + "name": "sitemap", "path": "", "baseName": "sitemap", "rel": "sitemap", @@ -2372,7 +2289,7 @@ }, { "mediaType": "application/manifest+json", - "name": "WebAppManifest", + "name": "webappmanifest", "path": "", "baseName": "manifest", "rel": "manifest", @@ -2389,7 +2306,7 @@ { "Example": "Single page in \"posts\" section", "Kind": "page", - "OutputFormat": "HTML", + "OutputFormat": "html", "Suffix": "html", "Template Lookup Order": [ "layouts/posts/single.html.html", @@ -2401,7 +2318,7 @@ { "Example": "Base template for single page in \"posts\" section", "Kind": "page", - "OutputFormat": "HTML", + "OutputFormat": "html", "Suffix": "html", "Template Lookup Order": [ "layouts/posts/single-baseof.html.html", @@ -2417,7 +2334,7 @@ { "Example": "Single page in \"posts\" section with layout set", "Kind": "page", - "OutputFormat": "HTML", + "OutputFormat": "html", "Suffix": "html", "Template Lookup Order": [ "layouts/posts/demolayout.html.html", @@ -2433,7 +2350,7 @@ { "Example": "Base template for single page in \"posts\" section with layout set", "Kind": "page", - "OutputFormat": "HTML", + "OutputFormat": "html", "Suffix": "html", "Template Lookup Order": [ "layouts/posts/demolayout-baseof.html.html", @@ -2453,7 +2370,7 @@ { "Example": "AMP single page", "Kind": "page", - "OutputFormat": "AMP", + "OutputFormat": "amp", "Suffix": "html", "Template Lookup Order": [ "layouts/posts/single.amp.html", @@ -2465,15 +2382,15 @@ { "Example": "AMP single page, French language", "Kind": "page", - "OutputFormat": "AMP", + "OutputFormat": "html", "Suffix": "html", "Template Lookup Order": [ - "layouts/posts/single.fr.amp.html", - "layouts/posts/single.amp.html", + "layouts/posts/single.fr.html.html", + "layouts/posts/single.html.html", "layouts/posts/single.fr.html", "layouts/posts/single.html", - "layouts/_default/single.fr.amp.html", - "layouts/_default/single.amp.html", + "layouts/_default/single.fr.html.html", + "layouts/_default/single.html.html", "layouts/_default/single.fr.html", "layouts/_default/single.html" ] @@ -2481,7 +2398,7 @@ { "Example": "Home page", "Kind": "home", - "OutputFormat": "HTML", + "OutputFormat": "html", "Suffix": "html", "Template Lookup Order": [ "layouts/index.html.html", @@ -2501,7 +2418,7 @@ { "Example": "Base template for home page", "Kind": "home", - "OutputFormat": "HTML", + "OutputFormat": "html", "Suffix": "html", "Template Lookup Order": [ "layouts/index-baseof.html.html", @@ -2525,7 +2442,7 @@ { "Example": "Home page with type set", "Kind": "home", - "OutputFormat": "HTML", + "OutputFormat": "html", "Suffix": "html", "Template Lookup Order": [ "layouts/demotype/index.html.html", @@ -2551,7 +2468,7 @@ { "Example": "Base template for home page with type set", "Kind": "home", - "OutputFormat": "HTML", + "OutputFormat": "html", "Suffix": "html", "Template Lookup Order": [ "layouts/demotype/index-baseof.html.html", @@ -2583,7 +2500,7 @@ { "Example": "Home page with layout set", "Kind": "home", - "OutputFormat": "HTML", + "OutputFormat": "html", "Suffix": "html", "Template Lookup Order": [ "layouts/demolayout.html.html", @@ -2607,7 +2524,7 @@ { "Example": "AMP home, French language", "Kind": "home", - "OutputFormat": "AMP", + "OutputFormat": "amp", "Suffix": "html", "Template Lookup Order": [ "layouts/index.fr.amp.html", @@ -2639,7 +2556,7 @@ { "Example": "JSON home", "Kind": "home", - "OutputFormat": "JSON", + "OutputFormat": "json", "Suffix": "json", "Template Lookup Order": [ "layouts/index.json.json", @@ -2659,7 +2576,7 @@ { "Example": "RSS home", "Kind": "home", - "OutputFormat": "RSS", + "OutputFormat": "rss", "Suffix": "xml", "Template Lookup Order": [ "layouts/index.rss.xml", @@ -2682,7 +2599,7 @@ { "Example": "RSS section posts", "Kind": "section", - "OutputFormat": "RSS", + "OutputFormat": "rss", "Suffix": "xml", "Template Lookup Order": [ "layouts/posts/section.rss.xml", @@ -2706,7 +2623,7 @@ { "Example": "Taxonomy in categories", "Kind": "taxonomy", - "OutputFormat": "RSS", + "OutputFormat": "rss", "Suffix": "xml", "Template Lookup Order": [ "layouts/categories/category.terms.rss.xml", @@ -2751,7 +2668,7 @@ { "Example": "Term in categories", "Kind": "term", - "OutputFormat": "RSS", + "OutputFormat": "rss", "Suffix": "xml", "Template Lookup Order": [ "layouts/categories/term.rss.xml", @@ -2805,7 +2722,7 @@ { "Example": "Section list for \"posts\" section", "Kind": "section", - "OutputFormat": "HTML", + "OutputFormat": "html", "Suffix": "html", "Template Lookup Order": [ "layouts/posts/posts.html.html", @@ -2831,7 +2748,7 @@ { "Example": "Section list for \"posts\" section with type set to \"blog\"", "Kind": "section", - "OutputFormat": "HTML", + "OutputFormat": "html", "Suffix": "html", "Template Lookup Order": [ "layouts/blog/posts.html.html", @@ -2863,7 +2780,7 @@ { "Example": "Section list for \"posts\" section with layout set to \"demoLayout\"", "Kind": "section", - "OutputFormat": "HTML", + "OutputFormat": "html", "Suffix": "html", "Template Lookup Order": [ "layouts/posts/demolayout.html.html", @@ -2895,7 +2812,7 @@ { "Example": "Taxonomy list in categories", "Kind": "taxonomy", - "OutputFormat": "HTML", + "OutputFormat": "html", "Suffix": "html", "Template Lookup Order": [ "layouts/categories/category.terms.html.html", @@ -2935,7 +2852,7 @@ { "Example": "Taxonomy term in categories", "Kind": "term", - "OutputFormat": "HTML", + "OutputFormat": "html", "Suffix": "html", "Template Lookup Order": [ "layouts/categories/term.html.html", @@ -3522,7 +3439,7 @@ }, "crypto": { "FNV32a": { - "Description": "FNV32a hashes v using fnv32a algorithm.", + "Description": "FNV32a hashes v using fnv32a algorithm.\n\u003cdocsmeta\u003e{\"newIn\": \"0.98.0\" }\u003c/docsmeta\u003e", "Args": [ "v" ], @@ -3652,6 +3569,12 @@ "map[string]interface {}{\n \"Hugo\": \"Rocks!\",\n}" ] ] + }, + "VisualizeSpaces": { + "Description": "", + "Args": null, + "Aliases": null, + "Examples": null } }, "diagrams": { @@ -3844,6 +3767,12 @@ "Args": null, "Aliases": null, "Examples": null + }, + "WorkingDir": { + "Description": "", + "Args": null, + "Aliases": null, + "Examples": null } }, "images": { @@ -4073,7 +4002,7 @@ ] }, "FormatNumberCustom": { - "Description": "FormatNumberCustom formats a number with the given precision using the\nnegative, decimal, and grouping options. The `options`\nparameter is a string consisting of `\u003cnegative\u003e \u003cdecimal\u003e \u003cgrouping\u003e`. The\ndefault `options` value is `- . ,`.\n\nNote that numbers are rounded up at 5 or greater.\nSo, with precision set to 0, 1.5 becomes `2`, and 1.4 becomes `1`.\n\nFor a simpler function that adapts to the current language, see FormatNumber.", + "Description": "FormatNumberCustom formats a number with the given precision. The first\noptions parameter is a space-delimited string of characters to represent\nnegativity, the decimal point, and grouping. The default value is `- . ,`.\nThe second options parameter defines an alternate delimiting character.\n\nNote that numbers are rounded up at 5 or greater.\nSo, with precision set to 0, 1.5 becomes `2`, and 1.4 becomes `1`.\n\nFor a simpler function that adapts to the current language, see FormatNumber.", "Args": [ "precision", "number", @@ -4097,6 +4026,10 @@ "{{ lang.FormatNumberCustom 0 -12345.6789 \"- . ,\" }}", "-12,346" ], + [ + "{{ lang.FormatNumberCustom 0 -12345.6789 \"-|.| \" \"|\" }}", + "-12 346" + ], [ "{{ -98765.4321 | lang.FormatNumberCustom 2 }}", "-98,765.43" @@ -4132,6 +4065,7 @@ "Translate": { "Description": "Translate returns a translated string for id.", "Args": [ + "ctx", "id", "args" ], @@ -4143,11 +4077,23 @@ } }, "math": { - "Add": { - "Description": "Add adds the two addends n1 and n2.", + "Abs": { + "Description": "Abs returns the absolute value of n.", "Args": [ - "n1", - "n2" + "n" + ], + "Aliases": null, + "Examples": [ + [ + "{{ math.Abs -2.1 }}", + "2.1" + ] + ] + }, + "Add": { + "Description": "Add adds the multivalued addends n1 and n2 or more values.", + "Args": [ + "inputs" ], "Aliases": [ "add" @@ -4181,8 +4127,7 @@ "Div": { "Description": "Div divides n1 by n2.", "Args": [ - "n1", - "n2" + "inputs" ], "Aliases": [ "div" @@ -4221,10 +4166,9 @@ ] }, "Max": { - "Description": "Max returns the greater of the two numbers n1 or n2.", + "Description": "Max returns the greater of the multivalued numbers n1 and n2 or more values.", "Args": [ - "n1", - "n2" + "inputs" ], "Aliases": null, "Examples": [ @@ -4235,10 +4179,9 @@ ] }, "Min": { - "Description": "Min returns the smaller of two numbers n1 or n2.", + "Description": "Min returns the smaller of multivalued numbers n1 and n2 or more values.", "Args": [ - "n1", - "n2" + "inputs" ], "Aliases": null, "Examples": [ @@ -4281,10 +4224,9 @@ ] }, "Mul": { - "Description": "Mul multiplies the two numbers n1 and n2.", + "Description": "Mul multiplies the multivalued numbers n1 and n2 or more values.", "Args": [ - "n1", - "n2" + "inputs" ], "Aliases": [ "mul" @@ -4339,10 +4281,9 @@ ] }, "Sub": { - "Description": "Sub subtracts n2 from n1.", + "Description": "Sub subtracts multivalued.", "Args": [ - "n1", - "n2" + "inputs" ], "Aliases": [ "sub" @@ -4630,7 +4571,7 @@ "Examples": null }, "GetRemote": { - "Description": "GetRemote gets the URL (via HTTP(s)) in the first argument in args and creates Resource object that can be used for\nfurther transformations.\n\nA second argument may be provided with an option map.\n\nNote: This method does not return any error as a second argument,\nfor any error situations the error can be checked in .Err.", + "Description": "GetRemote gets the URL (via HTTP(s)) in the first argument in args and creates Resource object that can be used for\nfurther transformations.\n\nA second argument may be provided with an option map.\n\nNote: This method does not return any error as a second return value,\nfor any error situations the error can be checked in .Err.", "Args": [ "args" ], @@ -4670,7 +4611,7 @@ "Examples": null }, "ToCSS": { - "Description": "ToCSS converts the given Resource to CSS. You can optional provide an Options\nobject or a target path (string) as first argument.", + "Description": "ToCSS converts the given Resource to CSS. You can optional provide an Options object\nas second argument. As an option, you can e.g. specify e.g. the target path (string)\nfor the converted CSS resource.", "Args": [ "args" ], @@ -4778,12 +4719,48 @@ } }, "site": { + "AllPages": { + "Description": "", + "Args": null, + "Aliases": null, + "Examples": null + }, + "Author": { + "Description": "", + "Args": null, + "Aliases": null, + "Examples": null + }, + "Authors": { + "Description": "", + "Args": null, + "Aliases": null, + "Examples": null + }, "BaseURL": { "Description": "", "Args": null, "Aliases": null, "Examples": null }, + "BuildDrafts": { + "Description": "", + "Args": null, + "Aliases": null, + "Examples": null + }, + "Config": { + "Description": "", + "Args": null, + "Aliases": null, + "Examples": null + }, + "Copyright": { + "Description": "", + "Args": null, + "Aliases": null, + "Examples": null + }, "Current": { "Description": "", "Args": null, @@ -4796,12 +4773,36 @@ "Aliases": null, "Examples": null }, + "DisqusShortname": { + "Description": "", + "Args": null, + "Aliases": null, + "Examples": null + }, "GetIdentity": { "Description": "", "Args": null, "Aliases": null, "Examples": null }, + "GetPage": { + "Description": "", + "Args": null, + "Aliases": null, + "Examples": null + }, + "GetPageWithTemplateInfo": { + "Description": "", + "Args": null, + "Aliases": null, + "Examples": null + }, + "GoogleAnalytics": { + "Description": "", + "Args": null, + "Aliases": null, + "Examples": null + }, "Home": { "Description": "", "Args": null, @@ -4814,6 +4815,12 @@ "Aliases": null, "Examples": null }, + "IsMultiLingual": { + "Description": "", + "Args": null, + "Aliases": null, + "Examples": null + }, "IsServer": { "Description": "", "Args": null, @@ -4826,12 +4833,36 @@ "Aliases": null, "Examples": null }, + "LanguageCode": { + "Description": "", + "Args": null, + "Aliases": null, + "Examples": null + }, + "LanguagePrefix": { + "Description": "", + "Args": null, + "Aliases": null, + "Examples": null + }, + "Languages": { + "Description": "", + "Args": null, + "Aliases": null, + "Examples": null + }, "LastChange": { "Description": "", "Args": null, "Aliases": null, "Examples": null }, + "MainSections": { + "Description": "", + "Args": null, + "Aliases": null, + "Examples": null + }, "Menus": { "Description": "", "Args": null, @@ -4844,6 +4875,12 @@ "Aliases": null, "Examples": null }, + "Param": { + "Description": "", + "Args": null, + "Aliases": null, + "Examples": null + }, "Params": { "Description": "", "Args": null, @@ -4856,6 +4893,12 @@ "Aliases": null, "Examples": null }, + "Sections": { + "Description": "", + "Args": null, + "Aliases": null, + "Examples": null + }, "ServerPort": { "Description": "", "Args": null, @@ -4868,6 +4911,12 @@ "Aliases": null, "Examples": null }, + "Social": { + "Description": "", + "Args": null, + "Aliases": null, + "Examples": null + }, "Taxonomies": { "Description": "", "Args": null, @@ -4991,7 +5040,7 @@ ] }, "FindRESubmatch": { - "Description": "FindRESubmatch returns returns a slice of strings holding the text of the leftmost match of the regular expression in s and the matches, if any, of its subexpressions.\n\nBy default all matches will be included. The number of matches can be limited with the optional limit parameter. A return value of nil indicates no match.", + "Description": "FindRESubmatch returns a slice of all successive matches of the regular\nexpression in content. Each element is a slice of strings holding the text\nof the leftmost match of the regular expression and the matches, if any, of\nits subexpressions.\n\nBy default all matches will be included. The number of matches can be\nlimited with the optional limit parameter. A return value of nil indicates\nno match.", "Args": [ "expr", "content", @@ -5041,10 +5090,24 @@ ] }, "HasSuffix": { - "Description": "", - "Args": null, - "Aliases": null, - "Examples": null + "Description": "HasSuffix tests whether the input s begins with suffix.", + "Args": [ + "s", + "suffix" + ], + "Aliases": [ + "hasSuffix" + ], + "Examples": [ + [ + "{{ hasSuffix \"Hugo\" \"go\" }}", + "true" + ], + [ + "{{ hasSuffix \"Hugo\" \"du\" }}", + "false" + ] + ] }, "Repeat": { "Description": "Repeat returns a new string consisting of n copies of the string s.", @@ -5592,6 +5655,23 @@ ] ] }, + "JoinPath": { + "Description": "JoinPath joins the provided elements into a URL string and cleans the result\nof any ./ or ../ elements. If the argument list is empty, JoinPath returns\nan empty string.", + "Args": [ + "elements" + ], + "Aliases": null, + "Examples": [ + [ + "{{ urls.JoinPath \"https://example.org\" \"foo\" }}", + "https://example.org/foo" + ], + [ + "{{ urls.JoinPath (slice \"a\" \"b\") }}", + "a/b" + ] + ] + }, "Parse": { "Description": "", "Args": null,