Squashed 'docs/' changes from 000ab7c42..4628b9ec2

4628b9ec2 commands: Regen CLI doc 2525f2ed0 data: Regenerate docs helper 6f5a0eb19 Add Hugo 0.30 poster image 72c3fac9e Merge branch 'chroma-next2' into next 364973d3f Fix typo in syntax highlighting. ce10cc02e Update Chroma highlighting docs 9dcc4d4dd Update robots.md 1e64cb483 Rename title of cross references' page d6dfbbc51 Add warning about MMark and TOCs e8d259d32 Fix link to subsection in page 6adead19d Merge commit '040d8d2833c26c53cf9f0e035910821ed50e3863' 040d8d283 Squashed 'themes/gohugoioTheme/' changes from cdaa89c8..6b632895 bde95d890 Add Atlas starter kit fc40d078d Remove page arg from examples of relref shortcode c578620b5 Remove page arg from examples of ref shortcode ee81931a4 Remove delimiters in YAML and TOML config examples 62d7b269f Clarify that .Lastmod automatically uses .GitInfo.AuthorDate (gohugoio#226) git-subtree-dir: docs git-subtree-split: 4628b9ec2c52df4de673a4d6b9621a65d8e8f5a4
mufidtk · Oct 15, 2017 · ecf5e08 · ecf5e08
1 parent dae5a7c
commit ecf5e08
Show file tree

Hide file tree

Showing 46 changed files with 12,024 additions and 200 deletions.
diff --git a/content/commands/hugo.md b/content/commands/hugo.md
@@ -1,5 +1,5 @@
 ---
-date: 2017-09-26T17:09:31-05:00
+date: 2017-10-15T10:19:48+02:00
 title: "hugo"
 slug: hugo
 url: /commands/hugo/
@@ -25,48 +25,50 @@ hugo [flags]
 ### Options
 
 ```
-  -b, --baseURL string             hostname (and path) to the root, e.g. http://spf13.com/
-  -D, --buildDrafts                include content marked as draft
-  -E, --buildExpired               include expired content
-  -F, --buildFuture                include content with publishdate in the future
-      --cacheDir string            filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
-      --canonifyURLs               if true, all relative URLs will be canonicalized using baseURL
-      --cleanDestinationDir        remove files from destination not found in static directories
-      --config string              config file (default is path/config.yaml|json|toml)
-  -c, --contentDir string          filesystem path to content directory
-      --debug                      debug output
-  -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.)
-      --disableRSS                 do not build RSS files
-      --disableSitemap             do not build Sitemap file
-      --enableGitInfo              add Git revision, date and author info to the pages
-      --forceSyncStatic            copy all files when static is changed.
-  -h, --help                       help for hugo
-      --i18n-warnings              print missing translations
-      --ignoreCache                ignores the cache directory
-  -l, --layoutDir string           filesystem path to layout directory
-      --log                        enable Logging
-      --logFile string             log File path (if set, logging enabled automatically)
-      --noChmod                    don't sync permission mode of files
-      --noTimes                    don't sync modification time of files
-      --pluralizeListTitles        pluralize titles in lists using inflect (default true)
-      --preserveTaxonomyNames      preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu")
-      --quiet                      build in quiet mode
-      --renderToMemory             render to memory (only useful for benchmark testing)
-  -s, --source string              filesystem path to read files relative from
-      --stepAnalysis               display memory and timing of different steps of the program
-      --templateMetrics            display metrics about template executions
-  -t, --theme string               theme to use (located in /themes/THEMENAME/)
-      --themesDir string           filesystem path to themes directory
-      --uglyURLs                   if true, use /filename.html instead of /filename/
-  -v, --verbose                    verbose output
-      --verboseLog                 verbose logging
-  -w, --watch                      watch filesystem for changes and recreate as needed
+  -b, --baseURL string          hostname (and path) to the root, e.g. http://spf13.com/
+  -D, --buildDrafts             include content marked as draft
+  -E, --buildExpired            include expired content
+  -F, --buildFuture             include content with publishdate in the future
+      --cacheDir string         filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
+      --canonifyURLs            if true, all relative URLs will be canonicalized using baseURL
+      --cleanDestinationDir     remove files from destination not found in static directories
+      --config string           config file (default is path/config.yaml|json|toml)
+  -c, --contentDir string       filesystem path to content directory
+      --debug                   debug output
+  -d, --destination string      filesystem path to write files to
+      --disable404              do not render 404 page
+      --disableKinds strings    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
+      --forceSyncStatic         copy all files when static is changed.
+  -h, --help                    help for hugo
+      --i18n-warnings           print missing translations
+      --ignoreCache             ignores the cache directory
+  -l, --layoutDir string        filesystem path to layout directory
+      --log                     enable Logging
+      --logFile string          log File path (if set, logging enabled automatically)
+      --noChmod                 don't sync permission mode of files
+      --noTimes                 don't sync modification time of files
+      --pluralizeListTitles     pluralize titles in lists using inflect (default true)
+      --preserveTaxonomyNames   preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu")
+      --quiet                   build in quiet mode
+      --renderToMemory          render to memory (only useful for benchmark testing)
+  -s, --source string           filesystem path to read files relative from
+      --stepAnalysis            display memory and timing of different steps of the program
+      --templateMetrics         display metrics about template executions
+      --templateMetricsHints    calculate some improvement hints when combined with --templateMetrics
+  -t, --theme string            theme to use (located in /themes/THEMENAME/)
+      --themesDir string        filesystem path to themes directory
+      --uglyURLs                if true, use /filename.html instead of /filename/
+  -v, --verbose                 verbose output
+      --verboseLog              verbose logging
+  -w, --watch                   watch filesystem for changes and recreate as needed
 ```
 
 ### SEE ALSO
 * [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 config](/commands/hugo_config/)	 - Print the site configuration
 * [hugo convert](/commands/hugo_convert/)	 - Convert your content to different formats
 * [hugo env](/commands/hugo_env/)	 - Print Hugo version and environment info
@@ -78,4 +80,4 @@ hugo [flags]
 * [hugo undraft](/commands/hugo_undraft/)	 - Undraft resets the content's draft status
 * [hugo version](/commands/hugo_version/)	 - Print the version number of Hugo
 
-###### Auto generated by spf13/cobra on 26-Sep-2017
+###### Auto generated by spf13/cobra on 15-Oct-2017
diff --git a/content/commands/hugo_benchmark.md b/content/commands/hugo_benchmark.md
@@ -1,5 +1,5 @@
 ---
-date: 2017-09-26T21:11:49+02:00
+date: 2017-10-15T10:19:48+02:00
 title: "hugo benchmark"
 slug: hugo_benchmark
 url: /commands/hugo_benchmark/
@@ -21,39 +21,40 @@ hugo benchmark [flags]
 ### Options
 
 ```
-  -b, --baseURL string             hostname (and path) to the root, e.g. http://spf13.com/
-  -D, --buildDrafts                include content marked as draft
-  -E, --buildExpired               include expired content
-  -F, --buildFuture                include content with publishdate in the future
-      --cacheDir string            filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
-      --canonifyURLs               if true, all relative URLs will be canonicalized using baseURL
-      --cleanDestinationDir        remove files from destination not found in static directories
-  -c, --contentDir string          filesystem path to content directory
-  -n, --count int                  number of times to build the site (default 13)
-      --cpuprofile string          path/filename for the CPU profile file
-  -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.)
-      --disableRSS                 do not build RSS files
-      --disableSitemap             do not build Sitemap file
-      --enableGitInfo              add Git revision, date and author info to the pages
-      --forceSyncStatic            copy all files when static is changed.
-  -h, --help                       help for benchmark
-      --i18n-warnings              print missing translations
-      --ignoreCache                ignores the cache directory
-  -l, --layoutDir string           filesystem path to layout directory
-      --memprofile string          path/filename for the memory profile file
-      --noChmod                    don't sync permission mode of files
-      --noTimes                    don't sync modification time of files
-      --pluralizeListTitles        pluralize titles in lists using inflect (default true)
-      --preserveTaxonomyNames      preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu")
-      --renderToMemory             render to memory (only useful for benchmark testing)
-  -s, --source string              filesystem path to read files relative from
-      --stepAnalysis               display memory and timing of different steps of the program
-      --templateMetrics            display metrics about template executions
-  -t, --theme string               theme to use (located in /themes/THEMENAME/)
-      --themesDir string           filesystem path to themes directory
-      --uglyURLs                   if true, use /filename.html instead of /filename/
+  -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/
+      --canonifyURLs            if true, all relative URLs will be canonicalized using baseURL
+      --cleanDestinationDir     remove files from destination not found in static directories
+  -c, --contentDir string       filesystem path to content directory
+  -n, --count int               number of times to build the site (default 13)
+      --cpuprofile string       path/filename for the CPU profile file
+  -d, --destination string      filesystem path to write files to
+      --disable404              do not render 404 page
+      --disableKinds strings    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
+      --forceSyncStatic         copy all files when static is changed.
+  -h, --help                    help for benchmark
+      --i18n-warnings           print missing translations
+      --ignoreCache             ignores the cache directory
+  -l, --layoutDir string        filesystem path to layout directory
+      --memprofile string       path/filename for the memory profile file
+      --noChmod                 don't sync permission mode of files
+      --noTimes                 don't sync modification time of files
+      --pluralizeListTitles     pluralize titles in lists using inflect (default true)
+      --preserveTaxonomyNames   preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu")
+      --renderToMemory          render to memory (only useful for benchmark testing)
+  -s, --source string           filesystem path to read files relative from
+      --stepAnalysis            display memory and timing of different steps of the program
+      --templateMetrics         display metrics about template executions
+      --templateMetricsHints    calculate some improvement hints when combined with --templateMetrics
+  -t, --theme string            theme to use (located in /themes/THEMENAME/)
+      --themesDir string        filesystem path to themes directory
+      --uglyURLs                if true, use /filename.html instead of /filename/
 ```
 
 ### Options inherited from parent commands
@@ -71,4 +72,4 @@ hugo benchmark [flags]
 ### SEE ALSO
 * [hugo](/commands/hugo/)	 - hugo builds your site
 
-###### Auto generated by spf13/cobra on 26-Sep-2017
+###### Auto generated by spf13/cobra on 15-Oct-2017
diff --git a/content/commands/hugo_check.md b/content/commands/hugo_check.md
@@ -1,5 +1,5 @@
 ---
-date: 2017-09-26T21:11:49+02:00
+date: 2017-10-15T10:19:48+02:00
 title: "hugo check"
 slug: hugo_check
 url: /commands/hugo_check/
@@ -35,4 +35,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-Sep-2017
+###### Auto generated by spf13/cobra on 15-Oct-2017
diff --git a/content/commands/hugo_check_ulimit.md b/content/commands/hugo_check_ulimit.md
@@ -1,5 +1,5 @@
 ---
-date: 2017-09-26T21:11:49+02:00
+date: 2017-10-15T10:19:48+02:00
 title: "hugo check ulimit"
 slug: hugo_check_ulimit
 url: /commands/hugo_check_ulimit/
@@ -39,4 +39,4 @@ hugo check ulimit [flags]
 ### SEE ALSO
 * [hugo check](/commands/hugo_check/)	 - Contains some verification checks
 
-###### Auto generated by spf13/cobra on 26-Sep-2017
+###### Auto generated by spf13/cobra on 15-Oct-2017
diff --git a/content/commands/hugo_config.md b/content/commands/hugo_config.md
@@ -1,5 +1,5 @@
 ---
-date: 2017-09-26T21:11:49+02:00
+date: 2017-10-15T10:19:48+02:00
 title: "hugo config"
 slug: hugo_config
 url: /commands/hugo_config/
@@ -38,4 +38,4 @@ hugo config [flags]
 ### SEE ALSO
 * [hugo](/commands/hugo/)	 - hugo builds your site
 
-###### Auto generated by spf13/cobra on 26-Sep-2017
+###### Auto generated by spf13/cobra on 15-Oct-2017
diff --git a/content/commands/hugo_convert.md b/content/commands/hugo_convert.md
@@ -1,5 +1,5 @@
 ---
-date: 2017-09-26T21:11:49+02:00
+date: 2017-10-15T10:19:48+02:00
 title: "hugo convert"
 slug: 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 toYAML](/commands/hugo_convert_toyaml/)	 - Convert front matter to YAML
 
-###### Auto generated by spf13/cobra on 26-Sep-2017
+###### Auto generated by spf13/cobra on 15-Oct-2017
diff --git a/content/commands/hugo_convert_toJSON.md b/content/commands/hugo_convert_toJSON.md
@@ -1,5 +1,5 @@
 ---
-date: 2017-09-26T21:11:49+02:00
+date: 2017-10-15T10:19:48+02:00
 title: "hugo convert toJSON"
 slug: hugo_convert_toJSON
 url: /commands/hugo_convert_tojson/
@@ -42,4 +42,4 @@ hugo convert toJSON [flags]
 ### SEE ALSO
 * [hugo convert](/commands/hugo_convert/)	 - Convert your content to different formats
 
-###### Auto generated by spf13/cobra on 26-Sep-2017
+###### Auto generated by spf13/cobra on 15-Oct-2017
diff --git a/content/commands/hugo_convert_toTOML.md b/content/commands/hugo_convert_toTOML.md
@@ -1,5 +1,5 @@
 ---
-date: 2017-09-26T21:11:49+02:00
+date: 2017-10-15T10:19:48+02:00
 title: "hugo convert toTOML"
 slug: hugo_convert_toTOML
 url: /commands/hugo_convert_totoml/
@@ -42,4 +42,4 @@ hugo convert toTOML [flags]
 ### SEE ALSO
 * [hugo convert](/commands/hugo_convert/)	 - Convert your content to different formats
 
-###### Auto generated by spf13/cobra on 26-Sep-2017
+###### Auto generated by spf13/cobra on 15-Oct-2017
diff --git a/content/commands/hugo_convert_toYAML.md b/content/commands/hugo_convert_toYAML.md
@@ -1,5 +1,5 @@
 ---
-date: 2017-09-26T21:11:49+02:00
+date: 2017-10-15T10:19:48+02:00
 title: "hugo convert toYAML"
 slug: hugo_convert_toYAML
 url: /commands/hugo_convert_toyaml/
@@ -42,4 +42,4 @@ hugo convert toYAML [flags]
 ### SEE ALSO
 * [hugo convert](/commands/hugo_convert/)	 - Convert your content to different formats
 
-###### Auto generated by spf13/cobra on 26-Sep-2017
+###### Auto generated by spf13/cobra on 15-Oct-2017
diff --git a/content/commands/hugo_env.md b/content/commands/hugo_env.md
@@ -1,5 +1,5 @@
 ---
-date: 2017-09-26T21:11:49+02:00
+date: 2017-10-15T10:19:48+02:00
 title: "hugo env"
 slug: hugo_env
 url: /commands/hugo_env/
@@ -38,4 +38,4 @@ hugo env [flags]
 ### SEE ALSO
 * [hugo](/commands/hugo/)	 - hugo builds your site
 
-###### Auto generated by spf13/cobra on 26-Sep-2017
+###### Auto generated by spf13/cobra on 15-Oct-2017
diff --git a/content/commands/hugo_gen.md b/content/commands/hugo_gen.md
@@ -1,5 +1,5 @@
 ---
-date: 2017-09-26T21:11:49+02:00
+date: 2017-10-15T10:19:48+02:00
 title: "hugo gen"
 slug: 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 man](/commands/hugo_gen_man/)	 - Generate man pages for the Hugo CLI
 
-###### Auto generated by spf13/cobra on 26-Sep-2017
+###### Auto generated by spf13/cobra on 15-Oct-2017
diff --git a/content/commands/hugo_gen_autocomplete.md b/content/commands/hugo_gen_autocomplete.md
@@ -1,5 +1,5 @@
 ---
-date: 2017-09-26T21:11:49+02:00
+date: 2017-10-15T10:19:48+02:00
 title: "hugo gen autocomplete"
 slug: hugo_gen_autocomplete
 url: /commands/hugo_gen_autocomplete/
@@ -56,4 +56,4 @@ hugo gen autocomplete [flags]
 ### SEE ALSO
 * [hugo gen](/commands/hugo_gen/)	 - A collection of several useful generators.
 
-###### Auto generated by spf13/cobra on 26-Sep-2017
+###### Auto generated by spf13/cobra on 15-Oct-2017
diff --git a/content/commands/hugo_gen_chromastyles.md b/content/commands/hugo_gen_chromastyles.md
@@ -1,5 +1,5 @@
 ---
-date: 2017-09-26T21:11:49+02:00
+date: 2017-10-15T10:19:48+02:00
 title: "hugo gen chromastyles"
 slug: hugo_gen_chromastyles
 url: /commands/hugo_gen_chromastyles/
@@ -43,4 +43,4 @@ hugo gen chromastyles [flags]
 ### SEE ALSO
 * [hugo gen](/commands/hugo_gen/)	 - A collection of several useful generators.
 
-###### Auto generated by spf13/cobra on 26-Sep-2017
+###### Auto generated by spf13/cobra on 15-Oct-2017
diff --git a/content/commands/hugo_gen_doc.md b/content/commands/hugo_gen_doc.md
@@ -1,5 +1,5 @@
 ---
-date: 2017-09-26T21:11:49+02:00
+date: 2017-10-15T10:19:48+02:00
 title: "hugo gen doc"
 slug: hugo_gen_doc
 url: /commands/hugo_gen_doc/
@@ -45,4 +45,4 @@ hugo gen doc [flags]
 ### SEE ALSO
 * [hugo gen](/commands/hugo_gen/)	 - A collection of several useful generators.
 
-###### Auto generated by spf13/cobra on 26-Sep-2017
+###### Auto generated by spf13/cobra on 15-Oct-2017
diff --git a/content/commands/hugo_gen_man.md b/content/commands/hugo_gen_man.md
@@ -1,5 +1,5 @@
 ---
-date: 2017-09-26T21:11:49+02:00
+date: 2017-10-15T10:19:48+02:00
 title: "hugo gen man"
 slug: hugo_gen_man
 url: /commands/hugo_gen_man/
@@ -41,4 +41,4 @@ hugo gen man [flags]
 ### SEE ALSO
 * [hugo gen](/commands/hugo_gen/)	 - A collection of several useful generators.
 
-###### Auto generated by spf13/cobra on 26-Sep-2017
+###### Auto generated by spf13/cobra on 15-Oct-2017
diff --git a/content/commands/hugo_import.md b/content/commands/hugo_import.md
@@ -1,5 +1,5 @@
 ---
-date: 2017-09-26T21:11:49+02:00
+date: 2017-10-15T10:19:48+02:00
 title: "hugo import"
 slug: 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 import jekyll](/commands/hugo_import_jekyll/)	 - hugo import from Jekyll
 
-###### Auto generated by spf13/cobra on 26-Sep-2017
+###### Auto generated by spf13/cobra on 15-Oct-2017
diff --git a/content/commands/hugo_import_jekyll.md b/content/commands/hugo_import_jekyll.md
@@ -1,5 +1,5 @@
 ---
-date: 2017-09-26T21:11:49+02:00
+date: 2017-10-15T10:19:48+02:00
 title: "hugo import jekyll"
 slug: hugo_import_jekyll
 url: /commands/hugo_import_jekyll/
@@ -41,4 +41,4 @@ hugo import jekyll [flags]
 ### SEE ALSO
 * [hugo import](/commands/hugo_import/)	 - Import your site from others.
 
-###### Auto generated by spf13/cobra on 26-Sep-2017
+###### Auto generated by spf13/cobra on 15-Oct-2017
diff --git a/content/commands/hugo_list.md b/content/commands/hugo_list.md
@@ -1,5 +1,5 @@
 ---
-date: 2017-09-26T21:11:49+02:00
+date: 2017-10-15T10:19:48+02:00
 title: "hugo list"
 slug: 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 future](/commands/hugo_list_future/)	 - List all posts dated in the future
 
-###### Auto generated by spf13/cobra on 26-Sep-2017
+###### Auto generated by spf13/cobra on 15-Oct-2017