github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-11-07 20:30:36 -05:00
Code Issues Projects Releases Packages Wiki Activity

Squashed 'docs/' changes from a042b67b5..3e663efb2

Browse source 
3e663efb2 Add poster for Hugo 0.31 release
b3c98ba65 Add doc about the new static dir support
2e62e4bdf Update multilingual docs for Hugo 0.31
8eff394b3 commands: Regenerate

git-subtree-dir: docs
git-subtree-split: 3e663efb2b149e243b6ecfdc439a2a2be573987f
This commit is contained in:
Bjørn Erik Pedersen 2017-11-20 11:19:16 +01:00
parent 05e42bc643
commit 30c0d485ea
31 changed files with 286 additions and 177 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

82
content/commands/hugo.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-10-15T10:19:48+02:00 date: 2017-11-18T10:28:35+01:00
title: "hugo" title: "hugo"
slug: hugo slug: hugo
url: /commands/hugo/ url: /commands/hugo/
@ -25,45 +25,45 @@ hugo [flags]
### Options ### Options
``` ```
-b, --baseURL string hostname (and path) to the root, e.g. http://spf13.com/ -b, --baseURL string hostname (and path) to the root, e.g. http://spf13.com/
-D, --buildDrafts include content marked as draft -D, --buildDrafts include content marked as draft
-E, --buildExpired include expired content -E, --buildExpired include expired content
-F, --buildFuture include content with publishdate in the future -F, --buildFuture include content with publishdate in the future
--cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ --cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
--canonifyURLs if true, all relative URLs will be canonicalized using baseURL --canonifyURLs if true, all relative URLs will be canonicalized using baseURL
--cleanDestinationDir remove files from destination not found in static directories --cleanDestinationDir remove files from destination not found in static directories
--config string config file (default is path/config.yaml|json|toml) --config string config file (default is path/config.yaml|json|toml)
-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 --disable404 do not render 404 page
--disableKinds strings disable different kind of pages (home, RSS etc.) --disableKinds stringSlice disable different kind of pages (home, RSS etc.)
--disableRSS do not build RSS files --disableRSS do not build RSS files
--disableSitemap do not build Sitemap file --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.
-h, --help help for hugo -h, --help help for hugo
--i18n-warnings print missing translations --i18n-warnings print missing translations
--ignoreCache ignores the cache directory --ignoreCache ignores the cache directory
-l, --layoutDir string filesystem path to layout directory -l, --layoutDir string filesystem path to layout directory
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)
--noChmod don't sync permission mode of files --noChmod don't sync permission mode of files
--noTimes don't sync modification time of files --noTimes don't sync modification time of files
--pluralizeListTitles pluralize titles in lists using inflect (default true) --pluralizeListTitles pluralize titles in lists using inflect (default true)
--preserveTaxonomyNames preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu") --preserveTaxonomyNames preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu")
--quiet build in quiet mode --quiet build in quiet mode
--renderToMemory render to memory (only useful for benchmark testing) --renderToMemory render to memory (only useful for benchmark testing)
-s, --source string filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--stepAnalysis display memory and timing of different steps of the program --stepAnalysis display memory and timing of different steps of the program
--templateMetrics display metrics about template executions --templateMetrics display metrics about template executions
--templateMetricsHints calculate some improvement hints when combined with --templateMetrics --templateMetricsHints calculate some improvement hints when combined with --templateMetrics
-t, --theme string theme to use (located in /themes/THEMENAME/) -t, --theme string theme to use (located in /themes/THEMENAME/)
--themesDir string filesystem path to themes directory --themesDir string filesystem path to themes directory
--uglyURLs if true, use /filename.html instead of /filename/ --uglyURLs if true, use /filename.html instead of /filename/
-v, --verbose verbose output -v, --verbose verbose output
--verboseLog verbose logging --verboseLog verbose logging
-w, --watch watch filesystem for changes and recreate as needed -w, --watch watch filesystem for changes and recreate as needed
``` ```
### SEE ALSO ### SEE ALSO
@ -80,4 +80,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 15-Oct-2017 ###### Auto generated by spf13/cobra on 18-Nov-2017

72
content/commands/hugo_benchmark.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-10-15T10:19:48+02:00 date: 2017-11-18T10:28:35+01:00
title: "hugo benchmark" title: "hugo benchmark"
slug: hugo_benchmark slug: hugo_benchmark
url: /commands/hugo_benchmark/ url: /commands/hugo_benchmark/
@ -21,40 +21,40 @@ hugo benchmark [flags]
### Options ### Options
``` ```
-b, --baseURL string hostname (and path) to the root, e.g. http://spf13.com/ -b, --baseURL string hostname (and path) to the root, e.g. http://spf13.com/
-D, --buildDrafts include content marked as draft -D, --buildDrafts include content marked as draft
-E, --buildExpired include expired content -E, --buildExpired include expired content
-F, --buildFuture include content with publishdate in the future -F, --buildFuture include content with publishdate in the future
--cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ --cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
--canonifyURLs if true, all relative URLs will be canonicalized using baseURL --canonifyURLs if true, all relative URLs will be canonicalized using baseURL
--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
-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 --disable404 do not render 404 page
--disableKinds strings disable different kind of pages (home, RSS etc.) --disableKinds stringSlice disable different kind of pages (home, RSS etc.)
--disableRSS do not build RSS files --disableRSS do not build RSS files
--disableSitemap do not build Sitemap file --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.
-h, --help help for benchmark -h, --help help for benchmark
--i18n-warnings print missing translations --i18n-warnings print missing translations
--ignoreCache ignores the cache directory --ignoreCache ignores the cache directory
-l, --layoutDir string filesystem path to layout directory -l, --layoutDir string filesystem path to layout directory
--memprofile string path/filename for the memory profile file --memprofile string path/filename for the memory profile file
--noChmod don't sync permission mode of files --noChmod don't sync permission mode of files
--noTimes don't sync modification time of files --noTimes don't sync modification time of files
--pluralizeListTitles pluralize titles in lists using inflect (default true) --pluralizeListTitles pluralize titles in lists using inflect (default true)
--preserveTaxonomyNames preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu") --preserveTaxonomyNames preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu")
--renderToMemory render to memory (only useful for benchmark testing) --renderToMemory render to memory (only useful for benchmark testing)
-s, --source string filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--stepAnalysis display memory and timing of different steps of the program --stepAnalysis display memory and timing of different steps of the program
--templateMetrics display metrics about template executions --templateMetrics display metrics about template executions
--templateMetricsHints calculate some improvement hints when combined with --templateMetrics --templateMetricsHints calculate some improvement hints when combined with --templateMetrics
-t, --theme string theme to use (located in /themes/THEMENAME/) -t, --theme string theme to use (located in /themes/THEMENAME/)
--themesDir string filesystem path to themes directory --themesDir string filesystem path to themes directory
--uglyURLs if true, use /filename.html instead of /filename/ --uglyURLs if true, use /filename.html instead of /filename/
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
@ -72,4 +72,4 @@ 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 15-Oct-2017 ###### Auto generated by spf13/cobra on 18-Nov-2017

4
content/commands/hugo_check.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-10-15T10:19:48+02:00 date: 2017-11-18T10:28:35+01:00
title: "hugo check" title: "hugo check"
slug: hugo_check slug: hugo_check
url: /commands/hugo_check/ url: /commands/hugo_check/
@ -35,4 +35,4 @@ Contains some verification checks
* [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 15-Oct-2017 ###### Auto generated by spf13/cobra on 18-Nov-2017

4
content/commands/hugo_check_ulimit.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-10-15T10:19:48+02:00 date: 2017-11-18T10:28:35+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/
@ -39,4 +39,4 @@ 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 15-Oct-2017 ###### Auto generated by spf13/cobra on 18-Nov-2017

4
content/commands/hugo_config.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-10-15T10:19:48+02:00 date: 2017-11-18T10:28:35+01:00
title: "hugo config" title: "hugo config"
slug: hugo_config slug: hugo_config
url: /commands/hugo_config/ url: /commands/hugo_config/
@ -38,4 +38,4 @@ 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 15-Oct-2017 ###### Auto generated by spf13/cobra on 18-Nov-2017

4
content/commands/hugo_convert.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-10-15T10:19:48+02:00 date: 2017-11-18T10:28:35+01:00
title: "hugo convert" title: "hugo convert"
slug: hugo_convert slug: hugo_convert
url: /commands/hugo_convert/ url: /commands/hugo_convert/
@ -42,4 +42,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 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 15-Oct-2017 ###### Auto generated by spf13/cobra on 18-Nov-2017

4
content/commands/hugo_convert_toJSON.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-10-15T10:19:48+02:00 date: 2017-11-18T10:28:35+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/
@ -42,4 +42,4 @@ 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 15-Oct-2017 ###### Auto generated by spf13/cobra on 18-Nov-2017

4
content/commands/hugo_convert_toTOML.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-10-15T10:19:48+02:00 date: 2017-11-18T10:28:35+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/
@ -42,4 +42,4 @@ 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 15-Oct-2017 ###### Auto generated by spf13/cobra on 18-Nov-2017

4
content/commands/hugo_convert_toYAML.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-10-15T10:19:48+02:00 date: 2017-11-18T10:28:35+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/
@ -42,4 +42,4 @@ 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 15-Oct-2017 ###### Auto generated by spf13/cobra on 18-Nov-2017

4
content/commands/hugo_env.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-10-15T10:19:48+02:00 date: 2017-11-18T10:28:35+01:00
title: "hugo env" title: "hugo env"
slug: hugo_env slug: hugo_env
url: /commands/hugo_env/ url: /commands/hugo_env/
@ -38,4 +38,4 @@ 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 15-Oct-2017 ###### Auto generated by spf13/cobra on 18-Nov-2017

4
content/commands/hugo_gen.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-10-15T10:19:48+02:00 date: 2017-11-18T10:28:35+01:00
title: "hugo gen" title: "hugo gen"
slug: hugo_gen slug: hugo_gen
url: /commands/hugo_gen/ url: /commands/hugo_gen/
@ -38,4 +38,4 @@ A collection of several useful generators.
* [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 15-Oct-2017 ###### Auto generated by spf13/cobra on 18-Nov-2017

4
content/commands/hugo_gen_autocomplete.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-10-15T10:19:48+02:00 date: 2017-11-18T10:28:35+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/
@ -56,4 +56,4 @@ 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 15-Oct-2017 ###### Auto generated by spf13/cobra on 18-Nov-2017

4
content/commands/hugo_gen_chromastyles.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-10-15T10:19:48+02:00 date: 2017-11-18T10:28:35+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/
@ -43,4 +43,4 @@ 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 15-Oct-2017 ###### Auto generated by spf13/cobra on 18-Nov-2017

4
content/commands/hugo_gen_doc.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-10-15T10:19:48+02:00 date: 2017-11-18T10:28:35+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/
@ -45,4 +45,4 @@ 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 15-Oct-2017 ###### Auto generated by spf13/cobra on 18-Nov-2017

4
content/commands/hugo_gen_man.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-10-15T10:19:48+02:00 date: 2017-11-18T10:28:35+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/
@ -41,4 +41,4 @@ 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 15-Oct-2017 ###### Auto generated by spf13/cobra on 18-Nov-2017

4
content/commands/hugo_import.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-10-15T10:19:48+02:00 date: 2017-11-18T10:28:35+01:00
title: "hugo import" title: "hugo import"
slug: hugo_import slug: hugo_import
url: /commands/hugo_import/ url: /commands/hugo_import/
@ -37,4 +37,4 @@ Import requires a subcommand, e.g. `hugo import jekyll jekyll_root_path target_p
* [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 15-Oct-2017 ###### Auto generated by spf13/cobra on 18-Nov-2017

4
content/commands/hugo_import_jekyll.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-10-15T10:19:48+02:00 date: 2017-11-18T10:28:35+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/
@ -41,4 +41,4 @@ 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 15-Oct-2017 ###### Auto generated by spf13/cobra on 18-Nov-2017

4
content/commands/hugo_list.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-10-15T10:19:48+02:00 date: 2017-11-18T10:28:35+01:00
title: "hugo list" title: "hugo list"
slug: hugo_list slug: hugo_list
url: /commands/hugo_list/ url: /commands/hugo_list/
@ -40,4 +40,4 @@ List requires a subcommand, e.g. `hugo list 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 15-Oct-2017 ###### Auto generated by spf13/cobra on 18-Nov-2017

4
content/commands/hugo_list_drafts.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-10-15T10:19:48+02:00 date: 2017-11-18T10:28:35+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/
@ -39,4 +39,4 @@ 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 15-Oct-2017 ###### Auto generated by spf13/cobra on 18-Nov-2017

4
content/commands/hugo_list_expired.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-10-15T10:19:48+02:00 date: 2017-11-18T10:28:35+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/
@ -40,4 +40,4 @@ 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 15-Oct-2017 ###### Auto generated by spf13/cobra on 18-Nov-2017

4
content/commands/hugo_list_future.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-10-15T10:19:48+02:00 date: 2017-11-18T10:28:35+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/
@ -40,4 +40,4 @@ 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 15-Oct-2017 ###### Auto generated by spf13/cobra on 18-Nov-2017

4
content/commands/hugo_new.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-10-15T10:19:48+02:00 date: 2017-11-18T10:28:35+01:00
title: "hugo new" title: "hugo new"
slug: hugo_new slug: hugo_new
url: /commands/hugo_new/ url: /commands/hugo_new/
@ -48,4 +48,4 @@ hugo new [path] [flags]
* [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 15-Oct-2017 ###### Auto generated by spf13/cobra on 18-Nov-2017

4
content/commands/hugo_new_site.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-10-15T10:19:48+02:00 date: 2017-11-18T10:28:35+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/
@ -43,4 +43,4 @@ 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 15-Oct-2017 ###### Auto generated by spf13/cobra on 18-Nov-2017

4
content/commands/hugo_new_theme.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-10-15T10:19:48+02:00 date: 2017-11-18T10:28:35+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/
@ -42,4 +42,4 @@ 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 15-Oct-2017 ###### Auto generated by spf13/cobra on 18-Nov-2017

88
content/commands/hugo_server.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-10-15T10:19:48+02:00 date: 2017-11-18T10:28:35+01:00
title: "hugo server" title: "hugo server"
slug: hugo_server slug: hugo_server
url: /commands/hugo_server/ url: /commands/hugo_server/
@ -31,48 +31,48 @@ hugo server [flags]
### Options ### Options
``` ```
--appendPort append port to baseURL (default true) --appendPort append port to baseURL (default true)
-b, --baseURL string hostname (and path) to the root, e.g. http://spf13.com/ -b, --baseURL string hostname (and path) to the root, e.g. http://spf13.com/
--bind string interface to which the server will bind (default "127.0.0.1") --bind string interface to which the server will bind (default "127.0.0.1")
-D, --buildDrafts include content marked as draft -D, --buildDrafts include content marked as draft
-E, --buildExpired include expired content -E, --buildExpired include expired content
-F, --buildFuture include content with publishdate in the future -F, --buildFuture include content with publishdate in the future
--cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ --cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
--canonifyURLs if true, all relative URLs will be canonicalized using baseURL --canonifyURLs if true, all relative URLs will be canonicalized using baseURL
--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 --disable404 do not render 404 page
--disableFastRender enables full re-renders on changes --disableFastRender enables full re-renders on changes
--disableKinds strings 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 --disableRSS do not build RSS files
--disableSitemap do not build Sitemap file --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.
-h, --help help for server -h, --help help for server
--i18n-warnings print missing translations --i18n-warnings print missing translations
--ignoreCache ignores the cache directory --ignoreCache ignores the cache directory
-l, --layoutDir string filesystem path to layout directory -l, --layoutDir string filesystem path to layout directory
--liveReloadPort int port for live reloading (i.e. 443 in HTTPS proxy situations) (default -1) --liveReloadPort int port for live reloading (i.e. 443 in HTTPS proxy situations) (default -1)
--meminterval string interval to poll memory usage (requires --memstats), valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". (default "100ms") --meminterval string interval to poll memory usage (requires --memstats), valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". (default "100ms")
--memstats string log memory usage to this file --memstats string log memory usage to this file
--navigateToChanged navigate to changed content file on live browser reload --navigateToChanged navigate to changed content file on live browser reload
--noChmod don't sync permission mode of files --noChmod don't sync permission mode of files
--noHTTPCache prevent HTTP caching --noHTTPCache prevent HTTP caching
--noTimes don't sync modification time of files --noTimes don't sync modification time of files
--pluralizeListTitles pluralize titles in lists using inflect (default true) --pluralizeListTitles pluralize titles in lists using inflect (default true)
-p, --port int port on which the server will listen (default 1313) -p, --port int port on which the server will listen (default 1313)
--preserveTaxonomyNames preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu") --preserveTaxonomyNames preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu")
--renderToDisk render to Destination path (default is render to memory & serve from there) --renderToDisk render to Destination path (default is render to memory & serve from there)
-s, --source string filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--stepAnalysis display memory and timing of different steps of the program --stepAnalysis display memory and timing of different steps of the program
--templateMetrics display metrics about template executions --templateMetrics display metrics about template executions
--templateMetricsHints calculate some improvement hints when combined with --templateMetrics --templateMetricsHints calculate some improvement hints when combined with --templateMetrics
-t, --theme string theme to use (located in /themes/THEMENAME/) -t, --theme string theme to use (located in /themes/THEMENAME/)
--themesDir string filesystem path to themes directory --themesDir string filesystem path to themes directory
--uglyURLs if true, use /filename.html instead of /filename/ --uglyURLs if true, use /filename.html instead of /filename/
-w, --watch watch filesystem for changes and recreate as needed (default true) -w, --watch watch filesystem for changes and recreate as needed (default true)
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
@ -90,4 +90,4 @@ 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 15-Oct-2017 ###### Auto generated by spf13/cobra on 18-Nov-2017

4
content/commands/hugo_undraft.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-10-15T10:19:48+02:00 date: 2017-11-18T10:28:35+01:00
title: "hugo undraft" title: "hugo undraft"
slug: hugo_undraft slug: hugo_undraft
url: /commands/hugo_undraft/ url: /commands/hugo_undraft/
@ -40,4 +40,4 @@ 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 15-Oct-2017 ###### Auto generated by spf13/cobra on 18-Nov-2017

4
content/commands/hugo_version.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2017-10-15T10:19:48+02:00 date: 2017-11-18T10:28:35+01:00
title: "hugo version" title: "hugo version"
slug: hugo_version slug: hugo_version
url: /commands/hugo_version/ url: /commands/hugo_version/
@ -38,4 +38,4 @@ 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 15-Oct-2017 ###### Auto generated by spf13/cobra on 18-Nov-2017

73
content/content-management/multilingual.md
View file

@ -59,6 +59,52 @@ If you want all of the languages to be put below their respective language code,
Only the obvious non-global options can be overridden per language. Examples of global options are `baseURL`, `buildDrafts`, etc. Only the obvious non-global options can be overridden per language. Examples of global options are `baseURL`, `buildDrafts`, etc.
## Configure Multilingual Multihost
From **Hugo 0.31** we support multiple languages in a multihost configuration. See [this issue](https://github.com/gohugoio/hugo/issues/4027) for details.
This means that you can now confugre a `baseURL` per `language`:
> If a `baseURL` is set on the `language` level, then all languages must have one and they must all be different.
Example:
```bash
[languages]
[languages.no]
baseURL = "https://example.no"
languageName = "Norsk"
weight = 1
title = "På norsk"
[languages.en]
baseURL = "https://example.com"
languageName = "English"
weight = 2
title = "In English"
```
With the above, the two sites will be generated into `public` with their own root:
```bash
public
├── en
└── no
```
**All URLs (i.e `.Permalink` etc.) will be generated from that root. So the English home page above will have its `.Permalink` set to `https://example.com/`.**
When you run `hugo server` we will start multiple HTTP servers. You will typlically see something like this in the console:
```bash
Web Server is available at 127.0.0.1:1313 (bind address 127.0.0.1)
Web Server is available at 127.0.0.1:1314 (bind address 127.0.0.1)
Press Ctrl+C to stop
```
Live reload and `--navigateToChanged` between the servers work as expected.
## Taxonomies and Blackfriday ## Taxonomies and Blackfriday
Taxonomies and [Blackfriday configuration][config] can also be set per language: Taxonomies and [Blackfriday configuration][config] can also be set per language:
@ -102,22 +148,28 @@ In this example, the `about.md` will be assigned the configured `defaultContentL
This way, you can slowly start to translate your current content without having to rename everything. If left unspecified, the default value for `defaultContentLanguage` is `en`. This way, you can slowly start to translate your current content without having to rename everything. If left unspecified, the default value for `defaultContentLanguage` is `en`.
By having the same *base filename*, the content pieces are linked together as translated pieces. By having the same **directory and base filename**, the content pieces are linked together as translated pieces.
You can also set the key used to link the translations explicitly in front matter:
```yaml
translationKey: "my-story"
```
{{% note %}}
**Before Hugo 0.31**, the file's directory was not considered when looking for translations. This did not work when you named all of your content files, say, `index.md`. Now we use the full content path.
{{% /note %}}
If you need distinct URLs per language, you can set the slug in the non-default language file. For example, you can define a custom slug for a French translation in the front matter of `content/about.fr.md` as follows: If you need distinct URLs per language, you can set the slug in the non-default language file. For example, you can define a custom slug for a French translation in the front matter of `content/about.fr.md` as follows:
``` ```yaml
slug: "a-propos" slug: "a-propos"
``` ```
At render, Hugo will build both `/about/` and `/a-propos/` as properly linked translated pages. At render, Hugo will build both `/about/` and `/a-propos/` as properly linked translated pages.
{{%note %}}
Hugo currently uses the base filename as the translation key, which can be an issue with identical filenames in different sections.
We will fix this in https://github.com/gohugoio/hugo/issues/2699
{{% /note %}}
{{< todo >}}Rewrite/remove the above one issue is fixed.{{< /todo >}}
## Link to Translated Content ## Link to Translated Content
@ -146,6 +198,13 @@ Hugo uses [go-i18n][] to support string translations. [See the project's source
Translations are collected from the `themes/<THEME>/i18n/` folder (built into the theme), as well as translations present in `i18n/` at the root of your project. In the `i18n`, the translations will be merged and take precedence over what is in the theme folder. Language files should be named according to [RFC 5646][] with names such as `en-US.toml`, `fr.toml`, etc. Translations are collected from the `themes/<THEME>/i18n/` folder (built into the theme), as well as translations present in `i18n/` at the root of your project. In the `i18n`, the translations will be merged and take precedence over what is in the theme folder. Language files should be named according to [RFC 5646][] with names such as `en-US.toml`, `fr.toml`, etc.
{{% note %}}
From **Hugo 0.31** you no longer need to use a valid language code. It _can be_ anything.
See https://github.com/gohugoio/hugo/issues/3564
{{% /note %}}
From within your templates, use the `i18n` function like this: From within your templates, use the `i18n` function like this:
``` ```

45
content/content-management/static-files.md Normal file
View file

@ -0,0 +1,45 @@
---
title: Static Files
description: "The `static` folder is where you place all your **static files**."
date: 2017-11-18
categories: [content management]
keywords: [source, directories]
menu:
docs:
parent: "content-management"
weight: 130
weight: 130 #rem
aliases: [/static-files]
toc: true
---
The `static` folder is where you place all your **static files**, e.g. stylesheets, JavaScript, images etc.
You can set the name of the static folder to use in your configuration file, for example `config.toml`. From **Hugo 0.31** you can configure as many static directories as you need. All the files in all the static directories will form a union filesystem.
Example:
```toml
staticDir = ["static1", "static2"]
[languages]
[languages.no]
staticDir = ["staticDir_override", "static_no"]
baseURL = "https://example.no"
languageName = "Norsk"
weight = 1
title = "På norsk"
[languages.en]
staticDir2 = "static_en"
baseURL = "https://example.com"
languageName = "English"
weight = 2
title = "In English"
```
In the above, with no theme used:
* The English site will get its static files as a union of "static1", "static2" and "static_en". On file duplicates, the right-most version will win.
* The Norwegian site will get its static files as a union of "staticDir_override" and "static_no".
**Note:** The example above is a [multihost setup](/content-management/multilingual/#configure-multilingual-multihost). In a regular setup, all the static directories will be available to all sites.

7
content/getting-started/directory-structure.md
View file

@ -57,9 +57,13 @@ used by Hugo when generating your website. You can write these files in YAML, JS
[`layouts`][] [`layouts`][]
: Stores templates in the form of `.html` files that specify how views of your content will be rendered into a static website. Templates include [list pages][lists], your [homepage][], [taxonomy templates][], [partials][], [single page templates][singles], and more. : Stores templates in the form of `.html` files that specify how views of your content will be rendered into a static website. Templates include [list pages][lists], your [homepage][], [taxonomy templates][], [partials][], [single page templates][singles], and more.
`static` [`static`][]
: stores all the static content for your future website: images, CSS, JavaScript, etc. When Hugo builds your site, all assets inside your static directory are copied over as-is. A good example of using the `static` folder is for [verifying site ownership on Google Search Console][searchconsole], where you want Hugo to copy over a complete HTML file without modifying its content. : stores all the static content for your future website: images, CSS, JavaScript, etc. When Hugo builds your site, all assets inside your static directory are copied over as-is. A good example of using the `static` folder is for [verifying site ownership on Google Search Console][searchconsole], where you want Hugo to copy over a complete HTML file without modifying its content.
{{% note %}}
From **Hugo 0.31** you can have multiple static directories.
{{% /note %}}
{{% note %}} {{% note %}}
Hugo does not currently ship with an asset pipeline ([#3207](https://github.com/gohugoio/hugo/issues/3207)). You can solicit support from the community in the [Hugo forums](https://discourse.gohugo.io) or check out a few of the [Hugo starter kits](/tools/starter-kits/) for examples of how Hugo developers are managing static assets. Hugo does not currently ship with an asset pipeline ([#3207](https://github.com/gohugoio/hugo/issues/3207)). You can solicit support from the community in the [Hugo forums](https://discourse.gohugo.io) or check out a few of the [Hugo starter kits](/tools/starter-kits/) for examples of how Hugo developers are managing static assets.
{{% /note %}} {{% /note %}}
@ -73,6 +77,7 @@ Hugo does not currently ship with an asset pipeline ([#3207](https://github.com/
[data templates]: /templates/data-templates/ [data templates]: /templates/data-templates/
[homepage]: /templates/homepage/ [homepage]: /templates/homepage/
[`layouts`]: /templates/ [`layouts`]: /templates/
[`static`]: /content-management/static-files/
[lists]: /templates/list/ [lists]: /templates/list/
[pagevars]: /variables/page/ [pagevars]: /variables/page/
[partials]: /templates/partials/ [partials]: /templates/partials/

BIN
static/images/blog/hugo-31-poster.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 64 KiB