github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-11-29 09:02:06 -05:00
Code Issues Projects Releases Packages Wiki Activity

docs: Regenerate CLI docs

Browse source
This commit is contained in:
Bjørn Erik Pedersen 2019-07-24 09:40:41 +02:00
parent 23adc0c2d9
commit 215d2ed883
No known key found for this signature in database
GPG key ID: 330E6E2BD4859D8F
34 changed files with 856 additions and 271 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
docs/content/en/commands/hugo.md
View file

@ -1,5 +1,5 @@
---
date: 2019-03-26
date: 2019-07-24
title: "hugo"
slug: hugo
url: /commands/hugo/
@ -43,6 +43,7 @@ hugo [flags]
-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)
@ -68,12 +69,14 @@ hugo [flags]
* [hugo check](/commands/hugo_check/) - Contains some verification checks
* [hugo config](/commands/hugo_config/) - Print the site configuration
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
* [hugo deploy](/commands/hugo_deploy/) - Deploy your site to a Cloud provider.
* [hugo env](/commands/hugo_env/) - Print Hugo version and environment info
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
* [hugo import](/commands/hugo_import/) - Import your site from others.
* [hugo list](/commands/hugo_list/) - Listing out various types of content
* [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
###### Auto generated by spf13/cobra on 26-Mar-2019
###### Auto generated by spf13/cobra on 24-Jul-2019

8
docs/content/en/commands/hugo_check.md
View file

@ -1,5 +1,5 @@
---
date: 2019-03-26
date: 2019-07-24
title: "hugo check"
slug: hugo_check
url: /commands/hugo_check/
@ -24,9 +24,13 @@ Contains some verification checks
--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
```
@ -36,4 +40,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 26-Mar-2019
###### Auto generated by spf13/cobra on 24-Jul-2019

8
docs/content/en/commands/hugo_check_ulimit.md
View file

@ -1,5 +1,5 @@
---
date: 2019-03-26
date: 2019-07-24
title: "hugo check ulimit"
slug: hugo_check_ulimit
url: /commands/hugo_check_ulimit/
@ -29,9 +29,13 @@ hugo check ulimit [flags]
--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
```
@ -40,4 +44,4 @@ hugo check ulimit [flags]
* [hugo check](/commands/hugo_check/) - Contains some verification checks
###### Auto generated by spf13/cobra on 26-Mar-2019
###### Auto generated by spf13/cobra on 24-Jul-2019

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

@ -1,5 +1,5 @@
---
date: 2019-03-26
date: 2019-07-24
title: "hugo config"
slug: hugo_config
url: /commands/hugo_config/
@ -20,7 +20,6 @@ hugo config [flags]
```
-h, --help help for config
-s, --source string filesystem path to read files relative from
```
### Options inherited from parent commands
@ -29,9 +28,13 @@ hugo config [flags]
--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
```
@ -40,4 +43,4 @@ hugo config [flags]
* [hugo](/commands/hugo/) - hugo builds your site
###### Auto generated by spf13/cobra on 26-Mar-2019
###### Auto generated by spf13/cobra on 24-Jul-2019

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

@ -1,5 +1,5 @@
---
date: 2019-03-26
date: 2019-07-24
title: "hugo convert"
slug: hugo_convert
url: /commands/hugo_convert/
@ -19,7 +19,6 @@ See convert's subcommands toJSON, toTOML and toYAML for more information.
```
-h, --help help for convert
-o, --output string filesystem path to write files to
-s, --source string filesystem path to read files relative from
--unsafe enable less safe operations, please backup first
```
@ -29,9 +28,13 @@ See convert's subcommands toJSON, toTOML and toYAML for more information.
--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
```
@ -43,4 +46,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 26-Mar-2019
###### Auto generated by spf13/cobra on 24-Jul-2019

7
docs/content/en/commands/hugo_convert_toJSON.md
View file

@ -1,5 +1,5 @@
---
date: 2019-03-26
date: 2019-07-24
title: "hugo convert toJSON"
slug: hugo_convert_toJSON
url: /commands/hugo_convert_tojson/
@ -29,11 +29,14 @@ hugo convert toJSON [flags]
--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
@ -43,4 +46,4 @@ hugo convert toJSON [flags]
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
###### Auto generated by spf13/cobra on 26-Mar-2019
###### Auto generated by spf13/cobra on 24-Jul-2019

7
docs/content/en/commands/hugo_convert_toTOML.md
View file

@ -1,5 +1,5 @@
---
date: 2019-03-26
date: 2019-07-24
title: "hugo convert toTOML"
slug: hugo_convert_toTOML
url: /commands/hugo_convert_totoml/
@ -29,11 +29,14 @@ hugo convert toTOML [flags]
--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
@ -43,4 +46,4 @@ hugo convert toTOML [flags]
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
###### Auto generated by spf13/cobra on 26-Mar-2019
###### Auto generated by spf13/cobra on 24-Jul-2019

7
docs/content/en/commands/hugo_convert_toYAML.md
View file

@ -1,5 +1,5 @@
---
date: 2019-03-26
date: 2019-07-24
title: "hugo convert toYAML"
slug: hugo_convert_toYAML
url: /commands/hugo_convert_toyaml/
@ -29,11 +29,14 @@ hugo convert toYAML [flags]
--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
@ -43,4 +46,4 @@ hugo convert toYAML [flags]
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
###### Auto generated by spf13/cobra on 26-Mar-2019
###### Auto generated by spf13/cobra on 24-Jul-2019

56
docs/content/en/commands/hugo_deploy.md Normal file
View file

@ -0,0 +1,56 @@
---
date: 2019-07-24
title: "hugo deploy"
slug: hugo_deploy
url: /commands/hugo_deploy/
---
## hugo deploy
Deploy your site to a Cloud provider.
### Synopsis
Deploy your site to a Cloud provider.
See https://gohugo.io/hosting-and-deployment/hugo-deploy/ for detailed
documentation.
```
hugo deploy [flags]
```
### Options
```
--confirm ask for confirmation before making changes to the target
--dryRun dry run
--force force upload of all files
-h, --help help for deploy
--invalidateCDN invalidate the CDN cache via the cloudFrontDistributionID listed in the deployment target (default true)
--maxDeletes int maximum # of files to delete, or -1 to disable (default 256)
--target string target deployment from deployments section in config file; defaults to the first one
```
### Options inherited from parent commands
```
--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
```
### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site
###### Auto generated by spf13/cobra on 24-Jul-2019

8
docs/content/en/commands/hugo_env.md
View file

@ -1,5 +1,5 @@
---
date: 2019-03-26
date: 2019-07-24
title: "hugo env"
slug: hugo_env
url: /commands/hugo_env/
@ -28,9 +28,13 @@ hugo env [flags]
--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
```
@ -39,4 +43,4 @@ hugo env [flags]
* [hugo](/commands/hugo/) - hugo builds your site
###### Auto generated by spf13/cobra on 26-Mar-2019
###### Auto generated by spf13/cobra on 24-Jul-2019

8
docs/content/en/commands/hugo_gen.md
View file

@ -1,5 +1,5 @@
---
date: 2019-03-26
date: 2019-07-24
title: "hugo gen"
slug: hugo_gen
url: /commands/hugo_gen/
@ -24,9 +24,13 @@ A collection of several useful generators.
--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
```
@ -39,4 +43,4 @@ A collection of several useful generators.
* [hugo gen doc](/commands/hugo_gen_doc/) - Generate Markdown documentation for the Hugo CLI.
* [hugo gen man](/commands/hugo_gen_man/) - Generate man pages for the Hugo CLI
###### Auto generated by spf13/cobra on 26-Mar-2019
###### Auto generated by spf13/cobra on 24-Jul-2019

8
docs/content/en/commands/hugo_gen_autocomplete.md
View file

@ -1,5 +1,5 @@
---
date: 2019-03-26
date: 2019-07-24
title: "hugo gen autocomplete"
slug: hugo_gen_autocomplete
url: /commands/hugo_gen_autocomplete/
@ -46,9 +46,13 @@ hugo gen autocomplete [flags]
--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
```
@ -57,4 +61,4 @@ hugo gen autocomplete [flags]
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
###### Auto generated by spf13/cobra on 26-Mar-2019
###### Auto generated by spf13/cobra on 24-Jul-2019

8
docs/content/en/commands/hugo_gen_chromastyles.md
View file

@ -1,5 +1,5 @@
---
date: 2019-03-26
date: 2019-07-24
title: "hugo gen chromastyles"
slug: hugo_gen_chromastyles
url: /commands/hugo_gen_chromastyles/
@ -33,9 +33,13 @@ hugo gen chromastyles [flags]
--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
```
@ -44,4 +48,4 @@ hugo gen chromastyles [flags]
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
###### Auto generated by spf13/cobra on 26-Mar-2019
###### Auto generated by spf13/cobra on 24-Jul-2019

8
docs/content/en/commands/hugo_gen_doc.md
View file

@ -1,5 +1,5 @@
---
date: 2019-03-26
date: 2019-07-24
title: "hugo gen doc"
slug: hugo_gen_doc
url: /commands/hugo_gen_doc/
@ -35,9 +35,13 @@ hugo gen doc [flags]
--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
```
@ -46,4 +50,4 @@ hugo gen doc [flags]
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
###### Auto generated by spf13/cobra on 26-Mar-2019
###### Auto generated by spf13/cobra on 24-Jul-2019

8
docs/content/en/commands/hugo_gen_man.md
View file

@ -1,5 +1,5 @@
---
date: 2019-03-26
date: 2019-07-24
title: "hugo gen man"
slug: hugo_gen_man
url: /commands/hugo_gen_man/
@ -31,9 +31,13 @@ hugo gen man [flags]
--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
```
@ -42,4 +46,4 @@ hugo gen man [flags]
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
###### Auto generated by spf13/cobra on 26-Mar-2019
###### Auto generated by spf13/cobra on 24-Jul-2019

8
docs/content/en/commands/hugo_import.md
View file

@ -1,5 +1,5 @@
---
date: 2019-03-26
date: 2019-07-24
title: "hugo import"
slug: hugo_import
url: /commands/hugo_import/
@ -26,9 +26,13 @@ Import requires a subcommand, e.g. `hugo import jekyll jekyll_root_path target_p
--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
```
@ -38,4 +42,4 @@ Import requires a subcommand, e.g. `hugo import jekyll jekyll_root_path target_p
* [hugo](/commands/hugo/) - hugo builds your site
* [hugo import jekyll](/commands/hugo_import_jekyll/) - hugo import from Jekyll
###### Auto generated by spf13/cobra on 26-Mar-2019
###### Auto generated by spf13/cobra on 24-Jul-2019

8
docs/content/en/commands/hugo_import_jekyll.md
View file

@ -1,5 +1,5 @@
---
date: 2019-03-26
date: 2019-07-24
title: "hugo import jekyll"
slug: hugo_import_jekyll
url: /commands/hugo_import_jekyll/
@ -31,9 +31,13 @@ hugo import jekyll [flags]
--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
```
@ -42,4 +46,4 @@ hugo import jekyll [flags]
* [hugo import](/commands/hugo_import/) - Import your site from others.
###### Auto generated by spf13/cobra on 26-Mar-2019
###### Auto generated by spf13/cobra on 24-Jul-2019

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

@ -1,5 +1,5 @@
---
date: 2019-03-26
date: 2019-07-24
title: "hugo list"
slug: hugo_list
url: /commands/hugo_list/
@ -18,7 +18,6 @@ List requires a subcommand, e.g. `hugo list drafts`.
```
-h, --help help for list
-s, --source string filesystem path to read files relative from
```
### Options inherited from parent commands
@ -27,9 +26,13 @@ List requires a subcommand, e.g. `hugo list drafts`.
--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
```
@ -37,8 +40,9 @@ List requires a subcommand, e.g. `hugo list drafts`.
### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site
* [hugo list all](/commands/hugo_list_all/) - List all posts
* [hugo list drafts](/commands/hugo_list_drafts/) - List all drafts
* [hugo list expired](/commands/hugo_list_expired/) - List all posts already expired
* [hugo list future](/commands/hugo_list_future/) - List all posts dated in the future
###### Auto generated by spf13/cobra on 26-Mar-2019
###### Auto generated by spf13/cobra on 24-Jul-2019

46
docs/content/en/commands/hugo_list_all.md Normal file
View file

@ -0,0 +1,46 @@
---
date: 2019-07-24
title: "hugo list all"
slug: hugo_list_all
url: /commands/hugo_list_all/
---
## hugo list all
List all posts
### Synopsis
List all of the posts in your content directory, include drafts, future and expired pages.
```
hugo list all [flags]
```
### Options
```
-h, --help help for all
```
### 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
```
### SEE ALSO
* [hugo list](/commands/hugo_list/) - Listing out various types of content
###### Auto generated by spf13/cobra on 24-Jul-2019

7
docs/content/en/commands/hugo_list_drafts.md
View file

@ -1,5 +1,5 @@
---
date: 2019-03-26
date: 2019-07-24
title: "hugo list drafts"
slug: hugo_list_drafts
url: /commands/hugo_list_drafts/
@ -28,10 +28,13 @@ hugo list drafts [flags]
--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
```
@ -40,4 +43,4 @@ hugo list drafts [flags]
* [hugo list](/commands/hugo_list/) - Listing out various types of content
###### Auto generated by spf13/cobra on 26-Mar-2019
###### Auto generated by spf13/cobra on 24-Jul-2019

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

@ -1,5 +1,5 @@
---
date: 2019-03-26
date: 2019-07-24
title: "hugo list expired"
slug: hugo_list_expired
url: /commands/hugo_list_expired/
@ -10,8 +10,7 @@ List all posts already expired
### Synopsis
List all of the posts in your content directory which has already
expired.
List all of the posts in your content directory which has already expired.
```
hugo list expired [flags]
@ -29,10 +28,13 @@ hugo list expired [flags]
--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
```
@ -41,4 +43,4 @@ hugo list expired [flags]
* [hugo list](/commands/hugo_list/) - Listing out various types of content
###### Auto generated by spf13/cobra on 26-Mar-2019
###### Auto generated by spf13/cobra on 24-Jul-2019

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

@ -1,5 +1,5 @@
---
date: 2019-03-26
date: 2019-07-24
title: "hugo list future"
slug: hugo_list_future
url: /commands/hugo_list_future/
@ -10,8 +10,7 @@ List all posts dated in the future
### Synopsis
List all of the posts in your content directory which will be
posted in the future.
List all of the posts in your content directory which will be posted in the future.
```
hugo list future [flags]
@ -29,10 +28,13 @@ hugo list future [flags]
--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
```
@ -41,4 +43,4 @@ hugo list future [flags]
* [hugo list](/commands/hugo_list/) - Listing out various types of content
###### Auto generated by spf13/cobra on 26-Mar-2019
###### Auto generated by spf13/cobra on 24-Jul-2019

83
docs/content/en/commands/hugo_mod.md Normal file
View file

@ -0,0 +1,83 @@
---
date: 2019-07-24
title: "hugo mod"
slug: hugo_mod
url: /commands/hugo_mod/
---
## hugo mod
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".
Note that Hugo will always start out by resolving the components defined in the site
configuration, provided by a _vendor directory (if no --ignoreVendor flag provided),
Go Modules, or a folder inside the themes directory, in that order.
See https://gohugo.io/hugo-modules/ for more information.
### 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
-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 and author info to the pages
--forceSyncStatic copy all files when static is changed.
--gc enable to run some cleanup tasks (remove unused cache files) after the build
-h, --help help for mod
--i18n-warnings print missing translations
--ignoreCache ignores the cache directory
-l, --layoutDir string filesystem path to layout directory
--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.
--templateMetrics display metrics about template executions
--templateMetricsHints calculate some improvement hints when combined with --templateMetrics
-t, --theme strings themes to use (located in /themes/THEMENAME/)
--trace file write trace to file (not useful in general)
```
### Options inherited from parent commands
```
--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
```
### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site
* [hugo mod clean](/commands/hugo_mod_clean/) - Delete the entire Hugo Module cache.
* [hugo mod get](/commands/hugo_mod_get/) - Resolves dependencies in your current Hugo Project.
* [hugo mod graph](/commands/hugo_mod_graph/) - Print a module dependency graph.
* [hugo mod init](/commands/hugo_mod_init/) - Initialize this project as a Hugo Module.
* [hugo mod tidy](/commands/hugo_mod_tidy/) - Remove unused entries in go.mod and go.sum.
* [hugo mod vendor](/commands/hugo_mod_vendor/) - Vendor all module dependencies into the _vendor directory.
###### Auto generated by spf13/cobra on 24-Jul-2019

52
docs/content/en/commands/hugo_mod_clean.md Normal file
View file

@ -0,0 +1,52 @@
---
date: 2019-07-24
title: "hugo mod clean"
slug: hugo_mod_clean
url: /commands/hugo_mod_clean/
---
## hugo mod clean
Delete the entire Hugo Module cache.
### Synopsis
Delete the entire Hugo Module cache.
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]
```
### Options
```
-h, --help help for clean
```
### 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
```
### SEE ALSO
* [hugo mod](/commands/hugo_mod/) - Various Hugo Modules helpers.
###### Auto generated by spf13/cobra on 24-Jul-2019

71
docs/content/en/commands/hugo_mod_get.md Normal file
View file

@ -0,0 +1,71 @@
---
date: 2019-07-24
title: "hugo mod get"
slug: hugo_mod_get
url: /commands/hugo_mod_get/
---
## hugo mod get
Resolves dependencies in your current Hugo Project.
### Synopsis
Resolves dependencies in your current Hugo Project.
Some examples:
Install the latest version possible for a given module:
hugo mod get github.com/gohugoio/testshortcodes
Install a specific version:
hugo mod get github.com/gohugoio/testshortcodes@v0.3.0
Install the latest versions of all module dependencies:
hugo mod get -u
Run "go help get" for more information. All flags available for "go get" is also relevant here.
Note that Hugo will always start out by resolving the components defined in the site
configuration, provided by a _vendor directory (if no --ignoreVendor flag provided),
Go Modules, or a folder inside the themes directory, in that order.
See https://gohugo.io/hugo-modules/ for more information.
```
hugo mod get [flags]
```
### Options
```
-h, --help help for get
```
### 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
```
### SEE ALSO
* [hugo mod](/commands/hugo_mod/) - Various Hugo Modules helpers.
###### Auto generated by spf13/cobra on 24-Jul-2019

48
docs/content/en/commands/hugo_mod_graph.md Normal file
View file

@ -0,0 +1,48 @@
---
date: 2019-07-24
title: "hugo mod graph"
slug: hugo_mod_graph
url: /commands/hugo_mod_graph/
---
## hugo mod graph
Print a module dependency graph.
### Synopsis
Print a module dependency graph with information about module status (disabled, vendored).
Note that for vendored modules, that is the version listed and not the one from go.mod.
```
hugo mod graph [flags]
```
### Options
```
-h, --help help for graph
```
### 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
```
### SEE ALSO
* [hugo mod](/commands/hugo_mod/) - Various Hugo Modules helpers.
###### Auto generated by spf13/cobra on 24-Jul-2019

53
docs/content/en/commands/hugo_mod_init.md Normal file
View file

@ -0,0 +1,53 @@
---
date: 2019-07-24
title: "hugo mod init"
slug: hugo_mod_init
url: /commands/hugo_mod_init/
---
## hugo mod init
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.
```
hugo mod init [flags]
```
### Options
```
-h, --help help for init
```
### 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
```
### SEE ALSO
* [hugo mod](/commands/hugo_mod/) - Various Hugo Modules helpers.
###### Auto generated by spf13/cobra on 24-Jul-2019

46
docs/content/en/commands/hugo_mod_tidy.md Normal file
View file

@ -0,0 +1,46 @@
---
date: 2019-07-24
title: "hugo mod tidy"
slug: hugo_mod_tidy
url: /commands/hugo_mod_tidy/
---
## hugo mod tidy
Remove unused entries in go.mod and go.sum.
### Synopsis
Remove unused entries in go.mod and go.sum.
```
hugo mod tidy [flags]
```
### Options
```
-h, --help help for tidy
```
### 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
```
### SEE ALSO
* [hugo mod](/commands/hugo_mod/) - Various Hugo Modules helpers.
###### Auto generated by spf13/cobra on 24-Jul-2019

49
docs/content/en/commands/hugo_mod_vendor.md Normal file
View file

@ -0,0 +1,49 @@
---
date: 2019-07-24
title: "hugo mod vendor"
slug: hugo_mod_vendor
url: /commands/hugo_mod_vendor/
---
## hugo mod vendor
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.
```
hugo mod vendor [flags]
```
### Options
```
-h, --help help for vendor
```
### 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
```
### SEE ALSO
* [hugo mod](/commands/hugo_mod/) - Various Hugo Modules helpers.
###### Auto generated by spf13/cobra on 24-Jul-2019

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

@ -1,5 +1,5 @@
---
date: 2019-03-26
date: 2019-07-24
title: "hugo new"
slug: hugo_new
url: /commands/hugo_new/
@ -37,7 +37,6 @@ hugo new [path] [flags]
--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 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 new
@ -49,11 +48,9 @@ hugo new [path] [flags]
--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.
-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)
```
@ -63,9 +60,13 @@ hugo new [path] [flags]
--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
```
@ -76,4 +77,4 @@ hugo new [path] [flags]
* [hugo new site](/commands/hugo_new_site/) - Create a new site (skeleton)
* [hugo new theme](/commands/hugo_new_theme/) - Create a new theme
###### Auto generated by spf13/cobra on 26-Mar-2019
###### Auto generated by spf13/cobra on 24-Jul-2019

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

@ -1,5 +1,5 @@
---
date: 2019-03-26
date: 2019-07-24
title: "hugo new site"
slug: hugo_new_site
url: /commands/hugo_new_site/
@ -32,10 +32,13 @@ hugo new site [path] [flags]
--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
```
@ -44,4 +47,4 @@ hugo new site [path] [flags]
* [hugo new](/commands/hugo_new/) - Create new content for your site
###### Auto generated by spf13/cobra on 26-Mar-2019
###### Auto generated by spf13/cobra on 24-Jul-2019

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

@ -1,5 +1,5 @@
---
date: 2019-03-26
date: 2019-07-24
title: "hugo new theme"
slug: hugo_new_theme
url: /commands/hugo_new_theme/
@ -31,10 +31,13 @@ hugo new theme [name] [flags]
--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
```
@ -43,4 +46,4 @@ hugo new theme [name] [flags]
* [hugo new](/commands/hugo_new/) - Create new content for your site
###### Auto generated by spf13/cobra on 26-Mar-2019
###### Auto generated by spf13/cobra on 24-Jul-2019

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

@ -1,5 +1,5 @@
---
date: 2019-03-26
date: 2019-07-24
title: "hugo server"
slug: hugo_server
url: /commands/hugo_server/
@ -45,7 +45,6 @@ hugo server [flags]
--disableKinds strings disable different kind of pages (home, RSS etc.)
--disableLiveReload watch without enabling live browser reload on rebuild
--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 server
@ -63,11 +62,9 @@ hugo server [flags]
--path-warnings print warnings on duplicate target paths etc.
-p, --port int port on which the server will listen (default 1313)
--renderToDisk render to Destination path (default is render to memory & serve from there)
-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)
```
@ -78,9 +75,13 @@ hugo server [flags]
--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
```
@ -89,4 +90,4 @@ hugo server [flags]
* [hugo](/commands/hugo/) - hugo builds your site
###### Auto generated by spf13/cobra on 26-Mar-2019
###### Auto generated by spf13/cobra on 24-Jul-2019

8
docs/content/en/commands/hugo_version.md
View file

@ -1,5 +1,5 @@
---
date: 2019-03-26
date: 2019-07-24
title: "hugo version"
slug: hugo_version
url: /commands/hugo_version/
@ -28,9 +28,13 @@ hugo version [flags]
--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
```
@ -39,4 +43,4 @@ hugo version [flags]
* [hugo](/commands/hugo/) - hugo builds your site
###### Auto generated by spf13/cobra on 26-Mar-2019
###### Auto generated by spf13/cobra on 24-Jul-2019