mirrors/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2025-04-29 23:20:49 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

docs: Re-generate CLI docs

Browse source
This commit is contained in:
Bjørn Erik Pedersen 2018-01-25 10:24:59 +01:00
parent d418c2c2ea
commit 1e27d05891
No known key found for this signature in database
GPG key ID: 330E6E2BD4859D8F
27 changed files with 81 additions and 90 deletions
Download patch file Download diff file Expand all files Collapse all files

9
docs/content/commands/hugo.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-12-28T18:49:29+01:00 date: 2018-01-25T10:24:52+01:00
title: "hugo" title: "hugo"
slug: hugo slug: hugo
url: /commands/hugo/ url: /commands/hugo/
@ -10,7 +10,6 @@ hugo builds your site
### Synopsis ### Synopsis
hugo is the main command, used to build your Hugo site. hugo is the main command, used to build your Hugo site.
Hugo is a Fast and Flexible Static Site Generator Hugo is a Fast and Flexible Static Site Generator
@ -36,10 +35,7 @@ hugo [flags]
-c, --contentDir string filesystem path to content directory -c, --contentDir string filesystem path to content directory
--debug debug output --debug debug output
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
--disable404 do not render 404 page
--disableKinds stringSlice disable different kind of pages (home, RSS etc.) --disableKinds stringSlice disable different kind of pages (home, RSS etc.)
--disableRSS do not build RSS files
--disableSitemap do not build Sitemap file
--enableGitInfo add Git revision, date and author info to the pages --enableGitInfo add Git revision, date and author info to the pages
--forceSyncStatic copy all files when static is changed. --forceSyncStatic copy all files when static is changed.
--gc enable to run some cleanup tasks (remove unused cache files) after the build --gc enable to run some cleanup tasks (remove unused cache files) after the build
@ -68,6 +64,7 @@ hugo [flags]
``` ```
### SEE ALSO ### SEE ALSO
* [hugo benchmark](/commands/hugo_benchmark/) - Benchmark Hugo by building a site a number of times. * [hugo benchmark](/commands/hugo_benchmark/) - Benchmark Hugo by building a site a number of times.
* [hugo check](/commands/hugo_check/) - Contains some verification checks * [hugo check](/commands/hugo_check/) - Contains some verification checks
* [hugo config](/commands/hugo_config/) - Print the site configuration * [hugo config](/commands/hugo_config/) - Print the site configuration
@ -81,4 +78,4 @@ hugo [flags]
* [hugo undraft](/commands/hugo_undraft/) - Undraft resets the content's draft status * [hugo undraft](/commands/hugo_undraft/) - Undraft resets the content's draft status
* [hugo version](/commands/hugo_version/) - Print the version number of Hugo * [hugo version](/commands/hugo_version/) - Print the version number of Hugo
###### Auto generated by spf13/cobra on 28-Dec-2017 ###### Auto generated by spf13/cobra on 25-Jan-2018

9
docs/content/commands/hugo_benchmark.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-12-28T18:49:29+01:00 date: 2018-01-25T10:24:52+01:00
title: "hugo benchmark" title: "hugo benchmark"
slug: hugo_benchmark slug: hugo_benchmark
url: /commands/hugo_benchmark/ url: /commands/hugo_benchmark/
@ -10,7 +10,6 @@ Benchmark Hugo by building a site a number of times.
### Synopsis ### Synopsis
Hugo can build a site many times over and analyze the running process Hugo can build a site many times over and analyze the running process
creating a benchmark. creating a benchmark.
@ -32,10 +31,7 @@ hugo benchmark [flags]
-n, --count int number of times to build the site (default 13) -n, --count int number of times to build the site (default 13)
--cpuprofile string path/filename for the CPU profile file --cpuprofile string path/filename for the CPU profile file
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
--disable404 do not render 404 page
--disableKinds stringSlice disable different kind of pages (home, RSS etc.) --disableKinds stringSlice disable different kind of pages (home, RSS etc.)
--disableRSS do not build RSS files
--disableSitemap do not build Sitemap file
--enableGitInfo add Git revision, date and author info to the pages --enableGitInfo add Git revision, date and author info to the pages
--forceSyncStatic copy all files when static is changed. --forceSyncStatic copy all files when static is changed.
--gc enable to run some cleanup tasks (remove unused cache files) after the build --gc enable to run some cleanup tasks (remove unused cache files) after the build
@ -71,6 +67,7 @@ hugo benchmark [flags]
``` ```
### SEE ALSO ### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site * [hugo](/commands/hugo/) - hugo builds your site
###### Auto generated by spf13/cobra on 28-Dec-2017 ###### Auto generated by spf13/cobra on 25-Jan-2018

6
docs/content/commands/hugo_check.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-12-28T18:49:29+01:00 date: 2018-01-25T10:24:52+01:00
title: "hugo check" title: "hugo check"
slug: hugo_check slug: hugo_check
url: /commands/hugo_check/ url: /commands/hugo_check/
@ -10,7 +10,6 @@ Contains some verification checks
### Synopsis ### Synopsis
Contains some verification checks Contains some verification checks
### Options ### Options
@ -32,7 +31,8 @@ Contains some verification checks
``` ```
### SEE ALSO ### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site * [hugo](/commands/hugo/) - hugo builds your site
* [hugo check ulimit](/commands/hugo_check_ulimit/) - Check system ulimit settings * [hugo check ulimit](/commands/hugo_check_ulimit/) - Check system ulimit settings
###### Auto generated by spf13/cobra on 28-Dec-2017 ###### Auto generated by spf13/cobra on 25-Jan-2018

6
docs/content/commands/hugo_check_ulimit.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-12-28T18:49:29+01:00 date: 2018-01-25T10:24:52+01:00
title: "hugo check ulimit" title: "hugo check ulimit"
slug: hugo_check_ulimit slug: hugo_check_ulimit
url: /commands/hugo_check_ulimit/ url: /commands/hugo_check_ulimit/
@ -10,7 +10,6 @@ Check system ulimit settings
### Synopsis ### Synopsis
Hugo will inspect the current ulimit settings on the system. Hugo will inspect the current ulimit settings on the system.
This is primarily to ensure that Hugo can watch enough files on some OSs This is primarily to ensure that Hugo can watch enough files on some OSs
@ -37,6 +36,7 @@ hugo check ulimit [flags]
``` ```
### SEE ALSO ### SEE ALSO
* [hugo check](/commands/hugo_check/) - Contains some verification checks * [hugo check](/commands/hugo_check/) - Contains some verification checks
###### Auto generated by spf13/cobra on 28-Dec-2017 ###### Auto generated by spf13/cobra on 25-Jan-2018

6
docs/content/commands/hugo_config.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-12-28T18:49:29+01:00 date: 2018-01-25T10:24:52+01:00
title: "hugo config" title: "hugo config"
slug: hugo_config slug: hugo_config
url: /commands/hugo_config/ url: /commands/hugo_config/
@ -10,7 +10,6 @@ Print the site configuration
### Synopsis ### Synopsis
Print the site configuration, both default and custom settings. Print the site configuration, both default and custom settings.
``` ```
@ -36,6 +35,7 @@ hugo config [flags]
``` ```
### SEE ALSO ### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site * [hugo](/commands/hugo/) - hugo builds your site
###### Auto generated by spf13/cobra on 28-Dec-2017 ###### Auto generated by spf13/cobra on 25-Jan-2018

6
docs/content/commands/hugo_convert.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-12-28T18:49:29+01:00 date: 2018-01-25T10:24:52+01:00
title: "hugo convert" title: "hugo convert"
slug: hugo_convert slug: hugo_convert
url: /commands/hugo_convert/ url: /commands/hugo_convert/
@ -10,7 +10,6 @@ Convert your content to different formats
### Synopsis ### Synopsis
Convert your content (e.g. front matter) to different formats. Convert your content (e.g. front matter) to different formats.
See convert's subcommands toJSON, toTOML and toYAML for more information. See convert's subcommands toJSON, toTOML and toYAML for more information.
@ -37,9 +36,10 @@ See convert's subcommands toJSON, toTOML and toYAML for more information.
``` ```
### SEE ALSO ### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site * [hugo](/commands/hugo/) - hugo builds your site
* [hugo convert toJSON](/commands/hugo_convert_tojson/) - Convert front matter to JSON * [hugo convert toJSON](/commands/hugo_convert_tojson/) - Convert front matter to JSON
* [hugo convert toTOML](/commands/hugo_convert_totoml/) - Convert front matter to TOML * [hugo convert toTOML](/commands/hugo_convert_totoml/) - Convert front matter to TOML
* [hugo convert toYAML](/commands/hugo_convert_toyaml/) - Convert front matter to YAML * [hugo convert toYAML](/commands/hugo_convert_toyaml/) - Convert front matter to YAML
###### Auto generated by spf13/cobra on 28-Dec-2017 ###### Auto generated by spf13/cobra on 25-Jan-2018

6
docs/content/commands/hugo_convert_toJSON.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-12-28T18:49:29+01:00 date: 2018-01-25T10:24:52+01:00
title: "hugo convert toJSON" title: "hugo convert toJSON"
slug: hugo_convert_toJSON slug: hugo_convert_toJSON
url: /commands/hugo_convert_tojson/ url: /commands/hugo_convert_tojson/
@ -10,7 +10,6 @@ Convert front matter to JSON
### Synopsis ### Synopsis
toJSON converts all front matter in the content directory toJSON converts all front matter in the content directory
to use JSON for the front matter. to use JSON for the front matter.
@ -40,6 +39,7 @@ hugo convert toJSON [flags]
``` ```
### SEE ALSO ### SEE ALSO
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats * [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
###### Auto generated by spf13/cobra on 28-Dec-2017 ###### Auto generated by spf13/cobra on 25-Jan-2018

6
docs/content/commands/hugo_convert_toTOML.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-12-28T18:49:29+01:00 date: 2018-01-25T10:24:52+01:00
title: "hugo convert toTOML" title: "hugo convert toTOML"
slug: hugo_convert_toTOML slug: hugo_convert_toTOML
url: /commands/hugo_convert_totoml/ url: /commands/hugo_convert_totoml/
@ -10,7 +10,6 @@ Convert front matter to TOML
### Synopsis ### Synopsis
toTOML converts all front matter in the content directory toTOML converts all front matter in the content directory
to use TOML for the front matter. to use TOML for the front matter.
@ -40,6 +39,7 @@ hugo convert toTOML [flags]
``` ```
### SEE ALSO ### SEE ALSO
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats * [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
###### Auto generated by spf13/cobra on 28-Dec-2017 ###### Auto generated by spf13/cobra on 25-Jan-2018

6
docs/content/commands/hugo_convert_toYAML.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-12-28T18:49:29+01:00 date: 2018-01-25T10:24:52+01:00
title: "hugo convert toYAML" title: "hugo convert toYAML"
slug: hugo_convert_toYAML slug: hugo_convert_toYAML
url: /commands/hugo_convert_toyaml/ url: /commands/hugo_convert_toyaml/
@ -10,7 +10,6 @@ Convert front matter to YAML
### Synopsis ### Synopsis
toYAML converts all front matter in the content directory toYAML converts all front matter in the content directory
to use YAML for the front matter. to use YAML for the front matter.
@ -40,6 +39,7 @@ hugo convert toYAML [flags]
``` ```
### SEE ALSO ### SEE ALSO
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats * [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
###### Auto generated by spf13/cobra on 28-Dec-2017 ###### Auto generated by spf13/cobra on 25-Jan-2018

6
docs/content/commands/hugo_env.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-12-28T18:49:29+01:00 date: 2018-01-25T10:24:52+01:00
title: "hugo env" title: "hugo env"
slug: hugo_env slug: hugo_env
url: /commands/hugo_env/ url: /commands/hugo_env/
@ -10,7 +10,6 @@ Print Hugo version and environment info
### Synopsis ### Synopsis
Print Hugo version and environment info. This is useful in Hugo bug reports. Print Hugo version and environment info. This is useful in Hugo bug reports.
``` ```
@ -36,6 +35,7 @@ hugo env [flags]
``` ```
### SEE ALSO ### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site * [hugo](/commands/hugo/) - hugo builds your site
###### Auto generated by spf13/cobra on 28-Dec-2017 ###### Auto generated by spf13/cobra on 25-Jan-2018

6
docs/content/commands/hugo_gen.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-12-28T18:49:29+01:00 date: 2018-01-25T10:24:52+01:00
title: "hugo gen" title: "hugo gen"
slug: hugo_gen slug: hugo_gen
url: /commands/hugo_gen/ url: /commands/hugo_gen/
@ -10,7 +10,6 @@ A collection of several useful generators.
### Synopsis ### Synopsis
A collection of several useful generators. A collection of several useful generators.
### Options ### Options
@ -32,10 +31,11 @@ A collection of several useful generators.
``` ```
### SEE ALSO ### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site * [hugo](/commands/hugo/) - hugo builds your site
* [hugo gen autocomplete](/commands/hugo_gen_autocomplete/) - Generate shell autocompletion script for Hugo * [hugo gen autocomplete](/commands/hugo_gen_autocomplete/) - Generate shell autocompletion script for Hugo
* [hugo gen chromastyles](/commands/hugo_gen_chromastyles/) - Generate CSS stylesheet for the Chroma code highlighter * [hugo gen chromastyles](/commands/hugo_gen_chromastyles/) - Generate CSS stylesheet for the Chroma code highlighter
* [hugo gen doc](/commands/hugo_gen_doc/) - Generate Markdown documentation for the Hugo CLI. * [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 * [hugo gen man](/commands/hugo_gen_man/) - Generate man pages for the Hugo CLI
###### Auto generated by spf13/cobra on 28-Dec-2017 ###### Auto generated by spf13/cobra on 25-Jan-2018

6
docs/content/commands/hugo_gen_autocomplete.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-12-28T18:49:29+01:00 date: 2018-01-25T10:24:52+01:00
title: "hugo gen autocomplete" title: "hugo gen autocomplete"
slug: hugo_gen_autocomplete slug: hugo_gen_autocomplete
url: /commands/hugo_gen_autocomplete/ url: /commands/hugo_gen_autocomplete/
@ -10,7 +10,6 @@ Generate shell autocompletion script for Hugo
### Synopsis ### Synopsis
Generates a shell autocompletion script for Hugo. Generates a shell autocompletion script for Hugo.
NOTE: The current version supports Bash only. NOTE: The current version supports Bash only.
@ -54,6 +53,7 @@ hugo gen autocomplete [flags]
``` ```
### SEE ALSO ### SEE ALSO
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators. * [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
###### Auto generated by spf13/cobra on 28-Dec-2017 ###### Auto generated by spf13/cobra on 25-Jan-2018

6
docs/content/commands/hugo_gen_chromastyles.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-12-28T18:49:29+01:00 date: 2018-01-25T10:24:52+01:00
title: "hugo gen chromastyles" title: "hugo gen chromastyles"
slug: hugo_gen_chromastyles slug: hugo_gen_chromastyles
url: /commands/hugo_gen_chromastyles/ url: /commands/hugo_gen_chromastyles/
@ -10,7 +10,6 @@ Generate CSS stylesheet for the Chroma code highlighter
### Synopsis ### Synopsis
Generate CSS stylesheet for the Chroma code highlighter for a given style. This stylesheet is needed if pygmentsUseClasses is enabled in config. Generate CSS stylesheet for the Chroma code highlighter for a given style. This stylesheet is needed if pygmentsUseClasses is enabled in config.
See https://help.farbox.com/pygments.html for preview of available styles See https://help.farbox.com/pygments.html for preview of available styles
@ -41,6 +40,7 @@ hugo gen chromastyles [flags]
``` ```
### SEE ALSO ### SEE ALSO
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators. * [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
###### Auto generated by spf13/cobra on 28-Dec-2017 ###### Auto generated by spf13/cobra on 25-Jan-2018

6
docs/content/commands/hugo_gen_doc.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-12-28T18:49:29+01:00 date: 2018-01-25T10:24:52+01:00
title: "hugo gen doc" title: "hugo gen doc"
slug: hugo_gen_doc slug: hugo_gen_doc
url: /commands/hugo_gen_doc/ url: /commands/hugo_gen_doc/
@ -10,7 +10,6 @@ Generate Markdown documentation for the Hugo CLI.
### Synopsis ### Synopsis
Generate Markdown documentation for the Hugo CLI. Generate Markdown documentation for the Hugo CLI.
This command is, mostly, used to create up-to-date documentation This command is, mostly, used to create up-to-date documentation
@ -43,6 +42,7 @@ hugo gen doc [flags]
``` ```
### SEE ALSO ### SEE ALSO
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators. * [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
###### Auto generated by spf13/cobra on 28-Dec-2017 ###### Auto generated by spf13/cobra on 25-Jan-2018

6
docs/content/commands/hugo_gen_man.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-12-28T18:49:29+01:00 date: 2018-01-25T10:24:52+01:00
title: "hugo gen man" title: "hugo gen man"
slug: hugo_gen_man slug: hugo_gen_man
url: /commands/hugo_gen_man/ url: /commands/hugo_gen_man/
@ -10,7 +10,6 @@ Generate man pages for the Hugo CLI
### Synopsis ### Synopsis
This command automatically generates up-to-date man pages of Hugo's This command automatically generates up-to-date man pages of Hugo's
command-line interface. By default, it creates the man page files command-line interface. By default, it creates the man page files
in the "man" directory under the current directory. in the "man" directory under the current directory.
@ -39,6 +38,7 @@ hugo gen man [flags]
``` ```
### SEE ALSO ### SEE ALSO
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators. * [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
###### Auto generated by spf13/cobra on 28-Dec-2017 ###### Auto generated by spf13/cobra on 25-Jan-2018

6
docs/content/commands/hugo_import.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-12-28T18:49:29+01:00 date: 2018-01-25T10:24:52+01:00
title: "hugo import" title: "hugo import"
slug: hugo_import slug: hugo_import
url: /commands/hugo_import/ url: /commands/hugo_import/
@ -10,7 +10,6 @@ Import your site from others.
### Synopsis ### Synopsis
Import your site from other web site generators like Jekyll. Import your site from other web site generators like Jekyll.
Import requires a subcommand, e.g. `hugo import jekyll jekyll_root_path target_path`. Import requires a subcommand, e.g. `hugo import jekyll jekyll_root_path target_path`.
@ -34,7 +33,8 @@ Import requires a subcommand, e.g. `hugo import jekyll jekyll_root_path target_p
``` ```
### SEE ALSO ### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site * [hugo](/commands/hugo/) - hugo builds your site
* [hugo import jekyll](/commands/hugo_import_jekyll/) - hugo import from Jekyll * [hugo import jekyll](/commands/hugo_import_jekyll/) - hugo import from Jekyll
###### Auto generated by spf13/cobra on 28-Dec-2017 ###### Auto generated by spf13/cobra on 25-Jan-2018

6
docs/content/commands/hugo_import_jekyll.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-12-28T18:49:29+01:00 date: 2018-01-25T10:24:52+01:00
title: "hugo import jekyll" title: "hugo import jekyll"
slug: hugo_import_jekyll slug: hugo_import_jekyll
url: /commands/hugo_import_jekyll/ url: /commands/hugo_import_jekyll/
@ -10,7 +10,6 @@ hugo import from Jekyll
### Synopsis ### Synopsis
hugo import from Jekyll. hugo import from Jekyll.
Import from Jekyll requires two paths, e.g. `hugo import jekyll jekyll_root_path target_path`. Import from Jekyll requires two paths, e.g. `hugo import jekyll jekyll_root_path target_path`.
@ -39,6 +38,7 @@ hugo import jekyll [flags]
``` ```
### SEE ALSO ### SEE ALSO
* [hugo import](/commands/hugo_import/) - Import your site from others. * [hugo import](/commands/hugo_import/) - Import your site from others.
###### Auto generated by spf13/cobra on 28-Dec-2017 ###### Auto generated by spf13/cobra on 25-Jan-2018

6
docs/content/commands/hugo_list.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-12-28T18:49:29+01:00 date: 2018-01-25T10:24:52+01:00
title: "hugo list" title: "hugo list"
slug: hugo_list slug: hugo_list
url: /commands/hugo_list/ url: /commands/hugo_list/
@ -10,7 +10,6 @@ Listing out various types of content
### Synopsis ### Synopsis
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`.
@ -35,9 +34,10 @@ List requires a subcommand, e.g. `hugo list drafts`.
``` ```
### SEE ALSO ### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site * [hugo](/commands/hugo/) - hugo builds your site
* [hugo list drafts](/commands/hugo_list_drafts/) - List all drafts * [hugo list drafts](/commands/hugo_list_drafts/) - List all drafts
* [hugo list expired](/commands/hugo_list_expired/) - List all posts already expired * [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 * [hugo list future](/commands/hugo_list_future/) - List all posts dated in the future
###### Auto generated by spf13/cobra on 28-Dec-2017 ###### Auto generated by spf13/cobra on 25-Jan-2018

6
docs/content/commands/hugo_list_drafts.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-12-28T18:49:29+01:00 date: 2018-01-25T10:24:52+01:00
title: "hugo list drafts" title: "hugo list drafts"
slug: hugo_list_drafts slug: hugo_list_drafts
url: /commands/hugo_list_drafts/ url: /commands/hugo_list_drafts/
@ -10,7 +10,6 @@ List all drafts
### Synopsis ### Synopsis
List all of the drafts in your content directory. List all of the drafts in your content directory.
``` ```
@ -37,6 +36,7 @@ hugo list drafts [flags]
``` ```
### SEE ALSO ### SEE ALSO
* [hugo list](/commands/hugo_list/) - Listing out various types of content * [hugo list](/commands/hugo_list/) - Listing out various types of content
###### Auto generated by spf13/cobra on 28-Dec-2017 ###### Auto generated by spf13/cobra on 25-Jan-2018

6
docs/content/commands/hugo_list_expired.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-12-28T18:49:29+01:00 date: 2018-01-25T10:24:52+01:00
title: "hugo list expired" title: "hugo list expired"
slug: hugo_list_expired slug: hugo_list_expired
url: /commands/hugo_list_expired/ url: /commands/hugo_list_expired/
@ -10,7 +10,6 @@ List all posts already expired
### Synopsis ### Synopsis
List all of the posts in your content directory which has already List all of the posts in your content directory which has already
expired. expired.
@ -38,6 +37,7 @@ hugo list expired [flags]
``` ```
### SEE ALSO ### SEE ALSO
* [hugo list](/commands/hugo_list/) - Listing out various types of content * [hugo list](/commands/hugo_list/) - Listing out various types of content
###### Auto generated by spf13/cobra on 28-Dec-2017 ###### Auto generated by spf13/cobra on 25-Jan-2018

6
docs/content/commands/hugo_list_future.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-12-28T18:49:29+01:00 date: 2018-01-25T10:24:52+01:00
title: "hugo list future" title: "hugo list future"
slug: hugo_list_future slug: hugo_list_future
url: /commands/hugo_list_future/ url: /commands/hugo_list_future/
@ -10,7 +10,6 @@ List all posts dated in the future
### Synopsis ### Synopsis
List all of the posts in your content directory which will be List all of the posts in your content directory which will be
posted in the future. posted in the future.
@ -38,6 +37,7 @@ hugo list future [flags]
``` ```
### SEE ALSO ### SEE ALSO
* [hugo list](/commands/hugo_list/) - Listing out various types of content * [hugo list](/commands/hugo_list/) - Listing out various types of content
###### Auto generated by spf13/cobra on 28-Dec-2017 ###### Auto generated by spf13/cobra on 25-Jan-2018

6
docs/content/commands/hugo_new.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-12-28T18:49:29+01:00 date: 2018-01-25T10:24:52+01:00
title: "hugo new" title: "hugo new"
slug: hugo_new slug: hugo_new
url: /commands/hugo_new/ url: /commands/hugo_new/
@ -10,7 +10,6 @@ Create new content for your site
### Synopsis ### Synopsis
Create a new content file and automatically set the date and title. 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. It will guess which kind of file to create based on the path provided.
@ -44,8 +43,9 @@ hugo new [path] [flags]
``` ```
### SEE ALSO ### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site * [hugo](/commands/hugo/) - hugo builds your site
* [hugo new site](/commands/hugo_new_site/) - Create a new site (skeleton) * [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 theme
###### Auto generated by spf13/cobra on 28-Dec-2017 ###### Auto generated by spf13/cobra on 25-Jan-2018

6
docs/content/commands/hugo_new_site.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-12-28T18:49:29+01:00 date: 2018-01-25T10:24:52+01:00
title: "hugo new site" title: "hugo new site"
slug: hugo_new_site slug: hugo_new_site
url: /commands/hugo_new_site/ url: /commands/hugo_new_site/
@ -10,7 +10,6 @@ Create a new site (skeleton)
### Synopsis ### Synopsis
Create a new site in the provided directory. Create a new site in the provided directory.
The new site will have the correct structure, but no content or theme yet. The new site will have the correct structure, but no content or theme yet.
Use `hugo new [contentPath]` to create new content. Use `hugo new [contentPath]` to create new content.
@ -41,6 +40,7 @@ hugo new site [path] [flags]
``` ```
### SEE ALSO ### SEE ALSO
* [hugo new](/commands/hugo_new/) - Create new content for your site * [hugo new](/commands/hugo_new/) - Create new content for your site
###### Auto generated by spf13/cobra on 28-Dec-2017 ###### Auto generated by spf13/cobra on 25-Jan-2018

6
docs/content/commands/hugo_new_theme.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-12-28T18:49:29+01:00 date: 2018-01-25T10:24:52+01:00
title: "hugo new theme" title: "hugo new theme"
slug: hugo_new_theme slug: hugo_new_theme
url: /commands/hugo_new_theme/ url: /commands/hugo_new_theme/
@ -10,7 +10,6 @@ Create a new theme
### Synopsis ### Synopsis
Create a new theme (skeleton) called [name] in the current directory. Create a new theme (skeleton) called [name] in the current directory.
New theme is a skeleton. Please add content to the touched files. Add your 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 name to the copyright line in the license and adjust the theme.toml file
@ -40,6 +39,7 @@ hugo new theme [name] [flags]
``` ```
### SEE ALSO ### SEE ALSO
* [hugo new](/commands/hugo_new/) - Create new content for your site * [hugo new](/commands/hugo_new/) - Create new content for your site
###### Auto generated by spf13/cobra on 28-Dec-2017 ###### Auto generated by spf13/cobra on 25-Jan-2018

9
docs/content/commands/hugo_server.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-12-28T18:49:29+01:00 date: 2018-01-25T10:24:52+01:00
title: "hugo server" title: "hugo server"
slug: hugo_server slug: hugo_server
url: /commands/hugo_server/ url: /commands/hugo_server/
@ -10,7 +10,6 @@ A high performance webserver
### Synopsis ### Synopsis
Hugo provides its own webserver which builds and serves the site. Hugo provides its own webserver which builds and serves the site.
While hugo server is high performance, it is a webserver with limited options. While hugo server is high performance, it is a webserver with limited options.
Many run it in production, but the standard behavior is for people to use it Many run it in production, but the standard behavior is for people to use it
@ -42,12 +41,9 @@ hugo server [flags]
--cleanDestinationDir remove files from destination not found in static directories --cleanDestinationDir remove files from destination not found in static directories
-c, --contentDir string filesystem path to content directory -c, --contentDir string filesystem path to content directory
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
--disable404 do not render 404 page
--disableFastRender enables full re-renders on changes --disableFastRender enables full re-renders on changes
--disableKinds stringSlice disable different kind of pages (home, RSS etc.) --disableKinds stringSlice disable different kind of pages (home, RSS etc.)
--disableLiveReload watch without enabling live browser reload on rebuild --disableLiveReload watch without enabling live browser reload on rebuild
--disableRSS do not build RSS files
--disableSitemap do not build Sitemap file
--enableGitInfo add Git revision, date and author info to the pages --enableGitInfo add Git revision, date and author info to the pages
--forceSyncStatic copy all files when static is changed. --forceSyncStatic copy all files when static is changed.
--gc enable to run some cleanup tasks (remove unused cache files) after the build --gc enable to run some cleanup tasks (remove unused cache files) after the build
@ -89,6 +85,7 @@ hugo server [flags]
``` ```
### SEE ALSO ### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site * [hugo](/commands/hugo/) - hugo builds your site
###### Auto generated by spf13/cobra on 28-Dec-2017 ###### Auto generated by spf13/cobra on 25-Jan-2018

6
docs/content/commands/hugo_undraft.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-12-28T18:49:29+01:00 date: 2018-01-25T10:24:52+01:00
title: "hugo undraft" title: "hugo undraft"
slug: hugo_undraft slug: hugo_undraft
url: /commands/hugo_undraft/ url: /commands/hugo_undraft/
@ -10,7 +10,6 @@ Undraft resets the content's draft status
### Synopsis ### Synopsis
Undraft resets the content's draft status Undraft resets the content's draft status
and updates the date to the current date and time. and updates the date to the current date and time.
If the content's draft status is 'False', nothing is done. If the content's draft status is 'False', nothing is done.
@ -38,6 +37,7 @@ hugo undraft path/to/content [flags]
``` ```
### SEE ALSO ### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site * [hugo](/commands/hugo/) - hugo builds your site
###### Auto generated by spf13/cobra on 28-Dec-2017 ###### Auto generated by spf13/cobra on 25-Jan-2018

6
docs/content/commands/hugo_version.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-12-28T18:49:29+01:00 date: 2018-01-25T10:24:52+01:00
title: "hugo version" title: "hugo version"
slug: hugo_version slug: hugo_version
url: /commands/hugo_version/ url: /commands/hugo_version/
@ -10,7 +10,6 @@ Print the version number of Hugo
### Synopsis ### Synopsis
All software has versions. This is Hugo's. All software has versions. This is Hugo's.
``` ```
@ -36,6 +35,7 @@ hugo version [flags]
``` ```
### SEE ALSO ### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site * [hugo](/commands/hugo/) - hugo builds your site
###### Auto generated by spf13/cobra on 28-Dec-2017 ###### Auto generated by spf13/cobra on 25-Jan-2018