Skip to content

Commit

Permalink
Squashed 'docs/' changes from 9b494a5..6b00298
Browse files Browse the repository at this point in the history
6b00298 Remove outdated "related example"
987f1e1 Fix dead links (#601)
96287a2 Add config option "summaryLength" (#600)
ced7f20 Adjust Over showcase
e334a63 Add new showcase: over
10435b5 Add warning about privacy options only work with internal templates (#525)
48c6b0e Minor grammatical fix
684670e Add quote
0e9fada Improvements to taxonomy template examples
e06c4bf Add syntax highlighting; consistent 4-space indentation
c1cb3f0 Remove dead links for custom permalinks
3e3aefd Fix 0a671bc
d658886 fix file name in 'Add Non-content Entries to a Menu' code toggle (#547)
1a05638 Add Solus install guide (#590)
8a0d65b Update Windows Installation instructions (#564)
c434863 Fix typo
0a671bc Add post to menu example
af14497 Add notes for `os.Stat` (Hugo 0.47) (#557)
e49f65b Singular to plural
cb5608d Update introduction.md
30b060d Add variable re-definition example (Hugo v0.48+)
2112396 Minor edits
fac3df0 Refresh the Go Templates introduction
4a9600e Updating URL to how-to-guide for hosting hugo site on firebase
bfaa777 add missing word
c2cb5d0 Tweak 'name: weight' to 'name: date' in example (#582)
5ea938a Remove some Scratch
2708dcd Release 0.48
e375d0f Merge branch 'temp48'
75e36c1 releaser: Prepare repository for 0.49-DEV
a6102f2 releaser: Add release notes to /docs for release of 0.48
41fc35d releaser: Bump versions for release of 0.48
64b9ecc Spell out the npm command for installing PostCSS
19e900a Improved Related Content doc
fe21600 Merge commit '844aef544c19e9d8f529b4f8144e089d0982bb34'
844aef5 Squashed 'themes/gohugoioTheme/' changes from 66249819..68ddff44
069828d Update git.md
d881d14 Make default "related" behavior more explicit
60b9160 Add docs for displaying 404 page on CloudFront
b72ebc7 Add .gitattributes to /resources
000cf85 Make the pros/cons styling consistent for summaries; use desc list
ebf1da9 Add note about outputStyle compressed
e3338ee Triple backquote syntax fix
361962a Add one more Blogger to Hugo tool for Windows (.NET Framework 4.5) (#540)
066606a Fix wrong link about Mmark Syntax Document
faee707 Added exitwp-for-hugo
6b41080 Add hugo-wrapper to starter-kits
4695dfb Added Utterances as Comments Alternatives.
c7ba9e3 Correct typo
beb850d Release 0.47.1
1cf417c Merge branch 'temp471'
0843bc4 releaser: Prepare repository for 0.48-DEV
8ff5c8b releaser: Add release notes to /docs for release of 0.47.1
e235343 releaser: Bump versions for release of 0.47.1
ffb1300 Update development.md
c22234e netlify: Minify output
5b9191c Release 0.47
bfd92cf releaser: Prepare repository for 0.48-DEV
ac7acf7 releaser: Add release notes to /docs for release of 0.47
b009609 releaser: Bump versions for release of 0.47
86a7ae4 docs: Regenerate CLI docs
d2c8b72 Merge commit 'a95896878f4b4a79448b39ce93a4e0d3258b4a43'
84de7ef Merge commit '3a44bf182fed5f34621f450114083a6dd7e88a07'

git-subtree-dir: docs
git-subtree-split: 6b00298
  • Loading branch information
bep committed Sep 14, 2018
1 parent a958968 commit 13e64d7
Show file tree
Hide file tree
Showing 75 changed files with 875 additions and 492 deletions.
2 changes: 1 addition & 1 deletion config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ twitter = "GoHugoIO"
[params]
description = "The world’s fastest framework for building websites"
## Used for views in rendered HTML (i.e., rather than using the .Hugo variable)
release = "0.46"
release = "0.48"
## Setting this to true will add a "noindex" to *EVERY* page on the site
removefromexternalsearch = false
## Gh repo for site footer (include trailing slash)
Expand Down
1 change: 1 addition & 0 deletions content/en/about/hugo-and-gdpr.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ toc: true
Note that:

* These settings have their defaults setting set to _off_, i.e. how it worked before Hugo `0.41`. You must do your own evaluation of your site and apply the appropriate settings.
* These settings work with the [internal templates](/templates/internal/). Some theme may contain custom templates for embedding services like Google Analytics. In that case these options have no effect.
* We will continue this work and improve this further in future Hugo versions.

## All Privacy Settings
Expand Down
79 changes: 40 additions & 39 deletions content/en/commands/hugo.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-04-16
date: 2018-08-17
title: "hugo"
slug: hugo
url: /commands/hugo/
Expand All @@ -24,43 +24,44 @@ 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 (deprecated) 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
--disableKinds stringSlice disable different kind of pages (home, RSS etc.)
--enableGitInfo add Git revision, date and author info to the pages
--forceSyncStatic copy all files when static is changed.
--gc enable to run some cleanup tasks (remove unused cache files) after the build
-h, --help help for 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 (deprecated) pluralize titles in lists using inflect (default true)
--preserveTaxonomyNames (deprecated) 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 (deprecated) 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 (deprecated) 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
--disableKinds strings disable different kind of pages (home, RSS etc.)
--enableGitInfo add Git revision, date and author info to the pages
--forceSyncStatic copy all files when static is changed.
--gc enable to run some cleanup tasks (remove unused cache files) after the build
-h, --help help for 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)
--minify minify any supported output format (HTML, XML etc.)
--noChmod don't sync permission mode of files
--noTimes don't sync modification time of files
--pluralizeListTitles (deprecated) pluralize titles in lists using inflect (default true)
--preserveTaxonomyNames (deprecated) 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 (deprecated) 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
Expand All @@ -77,4 +78,4 @@ hugo [flags]
* [hugo server](/commands/hugo_server/) - A high performance webserver
* [hugo version](/commands/hugo_version/) - Print the version number of Hugo

###### Auto generated by spf13/cobra on 16-Apr-2018
###### Auto generated by spf13/cobra on 17-Aug-2018
68 changes: 34 additions & 34 deletions content/en/commands/hugo_benchmark.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-04-16
date: 2018-08-17
title: "hugo benchmark"
slug: hugo_benchmark
url: /commands/hugo_benchmark/
Expand All @@ -20,38 +20,38 @@ 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 (deprecated) 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
--disableKinds stringSlice disable different kind of pages (home, RSS etc.)
--enableGitInfo add Git revision, date and author info to the pages
--forceSyncStatic copy all files when static is changed.
--gc enable to run some cleanup tasks (remove unused cache files) after the build
-h, --help help for 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 (deprecated) pluralize titles in lists using inflect (default true)
--preserveTaxonomyNames (deprecated) 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 (deprecated) 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 (deprecated) 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
--disableKinds strings disable different kind of pages (home, RSS etc.)
--enableGitInfo add Git revision, date and author info to the pages
--forceSyncStatic copy all files when static is changed.
--gc enable to run some cleanup tasks (remove unused cache files) after the build
-h, --help help for 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 (deprecated) pluralize titles in lists using inflect (default true)
--preserveTaxonomyNames (deprecated) 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 (deprecated) if true, use /filename.html instead of /filename/
```

### Options inherited from parent commands
Expand All @@ -70,4 +70,4 @@ hugo benchmark [flags]

* [hugo](/commands/hugo/) - hugo builds your site

###### Auto generated by spf13/cobra on 16-Apr-2018
###### Auto generated by spf13/cobra on 17-Aug-2018
4 changes: 2 additions & 2 deletions content/en/commands/hugo_check.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-04-16
date: 2018-08-17
title: "hugo check"
slug: hugo_check
url: /commands/hugo_check/
Expand Down Expand Up @@ -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 16-Apr-2018
###### Auto generated by spf13/cobra on 17-Aug-2018
4 changes: 2 additions & 2 deletions content/en/commands/hugo_check_ulimit.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-04-16
date: 2018-08-17
title: "hugo check ulimit"
slug: hugo_check_ulimit
url: /commands/hugo_check_ulimit/
Expand Down Expand Up @@ -39,4 +39,4 @@ hugo check ulimit [flags]

* [hugo check](/commands/hugo_check/) - Contains some verification checks

###### Auto generated by spf13/cobra on 16-Apr-2018
###### Auto generated by spf13/cobra on 17-Aug-2018
4 changes: 2 additions & 2 deletions content/en/commands/hugo_config.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-04-16
date: 2018-08-17
title: "hugo config"
slug: hugo_config
url: /commands/hugo_config/
Expand Down Expand Up @@ -39,4 +39,4 @@ hugo config [flags]

* [hugo](/commands/hugo/) - hugo builds your site

###### Auto generated by spf13/cobra on 16-Apr-2018
###### Auto generated by spf13/cobra on 17-Aug-2018
4 changes: 2 additions & 2 deletions content/en/commands/hugo_convert.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-04-16
date: 2018-08-17
title: "hugo convert"
slug: hugo_convert
url: /commands/hugo_convert/
Expand Down Expand Up @@ -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 16-Apr-2018
###### Auto generated by spf13/cobra on 17-Aug-2018
4 changes: 2 additions & 2 deletions content/en/commands/hugo_convert_toJSON.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-04-16
date: 2018-08-17
title: "hugo convert toJSON"
slug: hugo_convert_toJSON
url: /commands/hugo_convert_tojson/
Expand Down Expand Up @@ -42,4 +42,4 @@ hugo convert toJSON [flags]

* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats

###### Auto generated by spf13/cobra on 16-Apr-2018
###### Auto generated by spf13/cobra on 17-Aug-2018
4 changes: 2 additions & 2 deletions content/en/commands/hugo_convert_toTOML.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-04-16
date: 2018-08-17
title: "hugo convert toTOML"
slug: hugo_convert_toTOML
url: /commands/hugo_convert_totoml/
Expand Down Expand Up @@ -42,4 +42,4 @@ hugo convert toTOML [flags]

* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats

###### Auto generated by spf13/cobra on 16-Apr-2018
###### Auto generated by spf13/cobra on 17-Aug-2018
4 changes: 2 additions & 2 deletions content/en/commands/hugo_convert_toYAML.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-04-16
date: 2018-08-17
title: "hugo convert toYAML"
slug: hugo_convert_toYAML
url: /commands/hugo_convert_toyaml/
Expand Down Expand Up @@ -42,4 +42,4 @@ hugo convert toYAML [flags]

* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats

###### Auto generated by spf13/cobra on 16-Apr-2018
###### Auto generated by spf13/cobra on 17-Aug-2018
4 changes: 2 additions & 2 deletions content/en/commands/hugo_env.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-04-16
date: 2018-08-17
title: "hugo env"
slug: hugo_env
url: /commands/hugo_env/
Expand Down Expand Up @@ -38,4 +38,4 @@ hugo env [flags]

* [hugo](/commands/hugo/) - hugo builds your site

###### Auto generated by spf13/cobra on 16-Apr-2018
###### Auto generated by spf13/cobra on 17-Aug-2018
4 changes: 2 additions & 2 deletions content/en/commands/hugo_gen.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-04-16
date: 2018-08-17
title: "hugo gen"
slug: hugo_gen
url: /commands/hugo_gen/
Expand Down Expand Up @@ -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 16-Apr-2018
###### Auto generated by spf13/cobra on 17-Aug-2018
4 changes: 2 additions & 2 deletions content/en/commands/hugo_gen_autocomplete.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-04-16
date: 2018-08-17
title: "hugo gen autocomplete"
slug: hugo_gen_autocomplete
url: /commands/hugo_gen_autocomplete/
Expand Down Expand Up @@ -56,4 +56,4 @@ hugo gen autocomplete [flags]

* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.

###### Auto generated by spf13/cobra on 16-Apr-2018
###### Auto generated by spf13/cobra on 17-Aug-2018
4 changes: 2 additions & 2 deletions content/en/commands/hugo_gen_chromastyles.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-04-16
date: 2018-08-17
title: "hugo gen chromastyles"
slug: hugo_gen_chromastyles
url: /commands/hugo_gen_chromastyles/
Expand Down Expand Up @@ -43,4 +43,4 @@ hugo gen chromastyles [flags]

* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.

###### Auto generated by spf13/cobra on 16-Apr-2018
###### Auto generated by spf13/cobra on 17-Aug-2018
4 changes: 2 additions & 2 deletions content/en/commands/hugo_gen_doc.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-04-16
date: 2018-08-17
title: "hugo gen doc"
slug: hugo_gen_doc
url: /commands/hugo_gen_doc/
Expand Down Expand Up @@ -45,4 +45,4 @@ hugo gen doc [flags]

* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.

###### Auto generated by spf13/cobra on 16-Apr-2018
###### Auto generated by spf13/cobra on 17-Aug-2018
4 changes: 2 additions & 2 deletions content/en/commands/hugo_gen_man.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-04-16
date: 2018-08-17
title: "hugo gen man"
slug: hugo_gen_man
url: /commands/hugo_gen_man/
Expand Down Expand Up @@ -41,4 +41,4 @@ hugo gen man [flags]

* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.

###### Auto generated by spf13/cobra on 16-Apr-2018
###### Auto generated by spf13/cobra on 17-Aug-2018
4 changes: 2 additions & 2 deletions content/en/commands/hugo_import.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-04-16
date: 2018-08-17
title: "hugo import"
slug: hugo_import
url: /commands/hugo_import/
Expand Down Expand Up @@ -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 16-Apr-2018
###### Auto generated by spf13/cobra on 17-Aug-2018
4 changes: 2 additions & 2 deletions content/en/commands/hugo_import_jekyll.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-04-16
date: 2018-08-17
title: "hugo import jekyll"
slug: hugo_import_jekyll
url: /commands/hugo_import_jekyll/
Expand Down Expand Up @@ -41,4 +41,4 @@ hugo import jekyll [flags]

* [hugo import](/commands/hugo_import/) - Import your site from others.

###### Auto generated by spf13/cobra on 16-Apr-2018
###### Auto generated by spf13/cobra on 17-Aug-2018
Loading

0 comments on commit 13e64d7

Please sign in to comment.