summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2020-09-13 21:58:10 +0200
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2020-09-13 21:58:10 +0200
commitc8da8eb1f5551e6d141843daab41cb0ddbb0de4b (patch)
tree75b4903c7958e53f18bb2c5cc2b3c983fc6f637d /docs
parent787da6bd5f5440649cf653ca9fb19dd0c6e7c604 (diff)
docs: Regenerate CLI docs
Diffstat (limited to 'docs')
-rw-r--r--docs/content/en/commands/hugo.md83
-rw-r--r--docs/content/en/commands/hugo_check.md29
-rw-r--r--docs/content/en/commands/hugo_check_ulimit.md29
-rw-r--r--docs/content/en/commands/hugo_config.md29
-rw-r--r--docs/content/en/commands/hugo_config_mounts.md29
-rw-r--r--docs/content/en/commands/hugo_convert.md29
-rw-r--r--docs/content/en/commands/hugo_convert_toJSON.md33
-rw-r--r--docs/content/en/commands/hugo_convert_toTOML.md33
-rw-r--r--docs/content/en/commands/hugo_convert_toYAML.md33
-rw-r--r--docs/content/en/commands/hugo_deploy.md29
-rw-r--r--docs/content/en/commands/hugo_env.md29
-rw-r--r--docs/content/en/commands/hugo_gen.md29
-rw-r--r--docs/content/en/commands/hugo_gen_autocomplete.md29
-rw-r--r--docs/content/en/commands/hugo_gen_chromastyles.md29
-rw-r--r--docs/content/en/commands/hugo_gen_doc.md29
-rw-r--r--docs/content/en/commands/hugo_gen_man.md29
-rw-r--r--docs/content/en/commands/hugo_import.md29
-rw-r--r--docs/content/en/commands/hugo_import_jekyll.md29
-rw-r--r--docs/content/en/commands/hugo_list.md29
-rw-r--r--docs/content/en/commands/hugo_list_all.md29
-rw-r--r--docs/content/en/commands/hugo_list_drafts.md29
-rw-r--r--docs/content/en/commands/hugo_list_expired.md29
-rw-r--r--docs/content/en/commands/hugo_list_future.md29
-rw-r--r--docs/content/en/commands/hugo_mod.md30
-rw-r--r--docs/content/en/commands/hugo_mod_clean.md29
-rw-r--r--docs/content/en/commands/hugo_mod_get.md29
-rw-r--r--docs/content/en/commands/hugo_mod_graph.md29
-rw-r--r--docs/content/en/commands/hugo_mod_init.md29
-rw-r--r--docs/content/en/commands/hugo_mod_npm.md48
-rw-r--r--docs/content/en/commands/hugo_mod_npm_pack.md57
-rw-r--r--docs/content/en/commands/hugo_mod_tidy.md29
-rw-r--r--docs/content/en/commands/hugo_mod_vendor.md29
-rw-r--r--docs/content/en/commands/hugo_mod_verify.md29
-rw-r--r--docs/content/en/commands/hugo_new.md29
-rw-r--r--docs/content/en/commands/hugo_new_site.md29
-rw-r--r--docs/content/en/commands/hugo_new_theme.md29
-rw-r--r--docs/content/en/commands/hugo_server.md29
-rw-r--r--docs/content/en/commands/hugo_version.md29
38 files changed, 679 insertions, 537 deletions
diff --git a/docs/content/en/commands/hugo.md b/docs/content/en/commands/hugo.md
index b14416b70..837760647 100644
--- a/docs/content/en/commands/hugo.md
+++ b/docs/content/en/commands/hugo.md
@@ -1,5 +1,5 @@
---
-date: 2020-09-07
+date: 2020-09-13
title: "hugo"
slug: hugo
url: /commands/hugo/
@@ -24,45 +24,46 @@ hugo [flags]
### Options
```
- -b, --baseURL string hostname (and path) to the root, e.g. http://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
- --config string config file (default is path/config.yaml|json|toml)
- --configDir string config dir (default "config")
- -c, --contentDir string filesystem path to content directory
- --debug debug output
- -d, --destination string filesystem path to write files to
- --disableKinds strings disable different kind of pages (home, RSS etc.)
- --enableGitInfo add Git revision, date and author 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 hugo
- --i18n-warnings print missing translations
- --ignoreCache ignores the cache directory
- --ignoreVendor ignores any _vendor directory
- -l, --layoutDir string filesystem path to layout directory
- --log enable Logging
- --logFile string log File path (if set, logging enabled automatically)
- --minify minify any supported output format (HTML, XML etc.)
- --noChmod don't sync permission mode of files
- --noTimes don't sync modification time of files
- --path-warnings print warnings on duplicate target paths etc.
- --print-mem print memory usage to screen at intervals
- --quiet build in quiet mode
- --renderToMemory render to memory (only useful for benchmark testing)
- -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)
- -v, --verbose verbose output
- --verboseLog verbose logging
- -w, --watch watch filesystem for changes and recreate as needed
+ -b, --baseURL string hostname (and path) to the root, e.g. http://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
+ --config string config file (default is path/config.yaml|json|toml)
+ --configDir string config dir (default "config")
+ -c, --contentDir string filesystem path to content directory
+ --debug debug output
+ -d, --destination string filesystem path to write files to
+ --disableKinds strings disable different kind of pages (home, RSS etc.)
+ --enableGitInfo add Git revision, date and author 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 hugo
+ --i18n-warnings print missing translations
+ --ignoreCache ignores the cache directory
+ --ignoreVendor ignores any _vendor directory
+ --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
+ -l, --layoutDir string filesystem path to layout directory
+ --log enable Logging
+ --logFile string log File path (if set, logging enabled automatically)
+ --minify minify any supported output format (HTML, XML etc.)
+ --noChmod don't sync permission mode of files
+ --noTimes don't sync modification time of files
+ --path-warnings print warnings on duplicate target paths etc.
+ --print-mem print memory usage to screen at intervals
+ --quiet build in quiet mode
+ --renderToMemory render to memory (only useful for benchmark testing)
+ -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)
+ -v, --verbose verbose output
+ --verboseLog verbose logging
+ -w, --watch watch filesystem for changes and recreate as needed
```
### SEE ALSO
@@ -80,4 +81,4 @@ hugo [flags]
* [hugo server](/commands/hugo_server/) - A high performance webserver
* [hugo version](/commands/hugo_version/) - Print the version number of Hugo
-###### Auto generated by spf13/cobra on 7-Sep-2020
+###### Auto generated by spf13/cobra on 13-Sep-2020
diff --git a/docs/content/en/commands/hugo_check.md b/docs/content/en/commands/hugo_check.md
index f2f6d7b70..c728668a4 100644
--- a/docs/content/en/commands/hugo_check.md
+++ b/docs/content/en/commands/hugo_check.md
@@ -1,5 +1,5 @@
---
-date: 2020-09-07
+date: 2020-09-13
title: "hugo check"
slug: hugo_check
url: /commands/hugo_check/
@@ -21,18 +21,19 @@ Contains some verification checks
### 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
- -e, --environment string build environment
- --ignoreVendor ignores any _vendor directory
- --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
+ --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
+ --ignoreVendor ignores any _vendor 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
+ -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
@@ -40,4 +41,4 @@ Contains some verification checks
* [hugo](/commands/hugo/) - hugo builds your site
* [hugo check ulimit](/commands/hugo_check_ulimit/) - Check system ulimit settings
-###### Auto generated by spf13/cobra on 7-Sep-2020
+###### Auto generated by spf13/cobra on 13-Sep-2020
diff --git a/docs/content/en/commands/hugo_check_ulimit.md b/docs/content/en/commands/hugo_check_ulimit.md
index c5d2db112..bdb2cf938 100644
--- a/docs/content/en/commands/hugo_check_ulimit.md
+++ b/docs/content/en/commands/hugo_check_ulimit.md
@@ -1,5 +1,5 @@
---
-date: 2020-09-07
+date: 2020-09-13
title: "hugo check ulimit"
slug: hugo_check_ulimit
url: /commands/hugo_check_ulimit/
@@ -26,22 +26,23 @@ hugo check ulimit [flags]
### 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
- -e, --environment string build environment
- --ignoreVendor ignores any _vendor directory
- --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
+ --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
+ --ignoreVendor ignores any _vendor 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
+ -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 check](/commands/hugo_check/) - Contains some verification checks
-###### Auto generated by spf13/cobra on 7-Sep-2020
+###### Auto generated by spf13/cobra on 13-Sep-2020
diff --git a/docs/content/en/commands/hugo_config.md b/docs/content/en/commands/hugo_config.md
index be4506922..4d9cc774d 100644
--- a/docs/content/en/commands/hugo_config.md
+++ b/docs/content/en/commands/hugo_config.md
@@ -1,5 +1,5 @@
---
-date: 2020-09-07
+date: 2020-09-13
title: "hugo config"
slug: hugo_config
url: /commands/hugo_config/
@@ -25,18 +25,19 @@ hugo config [flags]
### 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
- -e, --environment string build environment
- --ignoreVendor ignores any _vendor directory
- --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
+ --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
+ --ignoreVendor ignores any _vendor 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
+ -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
@@ -44,4 +45,4 @@ hugo config [flags]
* [hugo](/commands/hugo/) - hugo builds your site
* [hugo config mounts](/commands/hugo_config_mounts/) - Print the configured file mounts
-###### Auto generated by spf13/cobra on 7-Sep-2020
+###### Auto generated by spf13/cobra on 13-Sep-2020
diff --git a/docs/content/en/commands/hugo_config_mounts.md b/docs/content/en/commands/hugo_config_mounts.md
index 5abac22ae..13e0e6ab0 100644
--- a/docs/content/en/commands/hugo_config_mounts.md
+++ b/docs/content/en/commands/hugo_config_mounts.md
@@ -1,5 +1,5 @@
---
-date: 2020-09-07
+date: 2020-09-13
title: "hugo config mounts"
slug: hugo_config_mounts
url: /commands/hugo_config_mounts/
@@ -25,22 +25,23 @@ hugo config mounts [flags]
### 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
- -e, --environment string build environment
- --ignoreVendor ignores any _vendor directory
- --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
+ --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
+ --ignoreVendor ignores any _vendor 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
+ -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 config](/commands/hugo_config/) - Print the site configuration
-###### Auto generated by spf13/cobra on 7-Sep-2020
+###### Auto generated by spf13/cobra on 13-Sep-2020
diff --git a/docs/content/en/commands/hugo_convert.md b/docs/content/en/commands/hugo_convert.md
index 86b01e8e7..4c3937c83 100644
--- a/docs/content/en/commands/hugo_convert.md
+++ b/docs/content/en/commands/hugo_convert.md
@@ -1,5 +1,5 @@
---
-date: 2020-09-07
+date: 2020-09-13
title: "hugo convert"
slug: hugo_convert
url: /commands/hugo_convert/
@@ -25,18 +25,19 @@ See convert's subcommands toJSON, toTOML and toYAML for more information.
### 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
- -e, --environment string build environment
- --ignoreVendor ignores any _vendor directory
- --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
+ --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
+ --ignoreVendor ignores any _vendor 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
+ -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
@@ -46,4 +47,4 @@ See convert's subcommands toJSON, toTOML and toYAML for more information.
* [hugo convert toTOML](/commands/hugo_convert_totoml/) - Convert front matter to TOML
* [hugo convert toYAML](/commands/hugo_convert_toyaml/) - Convert front matter to YAML
-###### Auto generated by spf13/cobra on 7-Sep-2020
+###### Auto generated by spf13/cobra on 13-Sep-2020
diff --git a/docs/content/en/commands/hugo_convert_toJSON.md b/docs/content/en/commands/hugo_convert_toJSON.md
index be5079f1d..38cd635db 100644
--- a/docs/content/en/commands/hugo_convert_toJSON.md
+++ b/docs/content/en/commands/hugo_convert_toJSON.md
@@ -1,5 +1,5 @@
---
-date: 2020-09-07
+date: 2020-09-13
title: "hugo convert toJSON"
slug: hugo_convert_toJSON
url: /commands/hugo_convert_tojson/
@@ -26,24 +26,25 @@ hugo convert toJSON [flags]
### 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
- -e, --environment string build environment
- --ignoreVendor ignores any _vendor directory
- --log enable Logging
- --logFile string log File path (if set, logging enabled automatically)
- -o, --output string filesystem path to write files to
- --quiet build in quiet mode
- -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
- -v, --verbose verbose output
- --verboseLog verbose logging
+ --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
+ --ignoreVendor ignores any _vendor 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)
+ -o, --output string filesystem path to write files to
+ --quiet build in quiet mode
+ -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
+ -v, --verbose verbose output
+ --verboseLog verbose logging
```
### SEE ALSO
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
-###### Auto generated by spf13/cobra on 7-Sep-2020
+###### Auto generated by spf13/cobra on 13-Sep-2020
diff --git a/docs/content/en/commands/hugo_convert_toTOML.md b/docs/content/en/commands/hugo_convert_toTOML.md
index ece0d542a..efef2e60c 100644
--- a/docs/content/en/commands/hugo_convert_toTOML.md
+++ b/docs/content/en/commands/hugo_convert_toTOML.md
@@ -1,5 +1,5 @@
---
-date: 2020-09-07
+date: 2020-09-13
title: "hugo convert toTOML"
slug: hugo_convert_toTOML
url: /commands/hugo_convert_totoml/
@@ -26,24 +26,25 @@ hugo convert toTOML [flags]
### 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
- -e, --environment string build environment
- --ignoreVendor ignores any _vendor directory
- --log enable Logging
- --logFile string log File path (if set, logging enabled automatically)
- -o, --output string filesystem path to write files to
- --quiet build in quiet mode
- -s, --source string filesystem