summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2019-02-01 09:01:04 +0100
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2019-02-01 09:01:04 +0100
commit5e078383a787e8b5ec3ba73f05ea4130840afbe2 (patch)
treeab398abdc1bee075ed5995cc7edff743a170b44e
parent978856e2ad12d2bcaf37bb9e31f806b30a4c42f4 (diff)
Squashed 'docs/' changes from 785e375f..49809a03
49809a03 Merge commit '20a631b4964fc0ab9137cce1e41774cbc17de044' 20a631b4 Squashed 'themes/gohugoioTheme/' changes from b8202f539..dafc91ff1 8b58f565 Re-generate CLI docs 4653a724 Add Netlify deployment badge 2d6246bc Remove some deprecated site variables e6777153 Improve Algolia Search Display Styling 1570999f Add missing "." in front of gitlab-ci.yaml example b922ae7d This adds documentation to the new configDir/Environment logic from .53 (#729) 7cff379f Correctly escape multi-word taxonomy terms in example 2dfeeda4 fix typo by removing stray paren 0870bd9a Fix typo in `paginate` description 91e8be85 Fixes https://github.com/gohugoio/hugo/issues/5609 c1db65ec Make the dummy URL more obvious b4589ff0 Fix a link b73dcb9a Consistently use "posts" as section name in examples 7a56abbc Format definitions a9c6fd9b Minor clarification over the last commit 5c86bdc8 Add alternative instructions for Quick Start for non-git users dafe7ee9 Add Visual Studio Code plug-ins 110ed19e Update HUGO_VERSION 2abd031a Update page.md b332f7b9 Update page.md f5a8c9d4 Update static-files.md 6d0c155c Add note about relative protocol URLs a13751ac Theme Warning: Remove note about unquoted URLs 4c8f7d68 Incorporate feedback 6f2b9cf0 Update Creating Themes Warning 40d88d98 Fix ToC example to use binary true/false 4a11f3f1 Fix typo 2dbfc0a4 Fix a typo in taxonomies d63790ef Do not mark UndocumentedFeature issues as stale d7aff095 Regenerate docs.json 71c0826f Update transform.Unmarshal.md git-subtree-dir: docs git-subtree-split: 49809a038b2691637bab7f3f2e385dde654a88b8
-rw-r--r--.github/stale.yml1
-rw-r--r--README.md2
-rw-r--r--content/en/commands/hugo.md6
-rw-r--r--content/en/commands/hugo_benchmark.md72
-rw-r--r--content/en/commands/hugo_check.md4
-rw-r--r--content/en/commands/hugo_check_ulimit.md4
-rw-r--r--content/en/commands/hugo_config.md4
-rw-r--r--content/en/commands/hugo_convert.md4
-rw-r--r--content/en/commands/hugo_convert_toJSON.md4
-rw-r--r--content/en/commands/hugo_convert_toTOML.md4
-rw-r--r--content/en/commands/hugo_convert_toYAML.md4
-rw-r--r--content/en/commands/hugo_env.md4
-rw-r--r--content/en/commands/hugo_gen.md4
-rw-r--r--content/en/commands/hugo_gen_autocomplete.md4
-rw-r--r--content/en/commands/hugo_gen_chromastyles.md4
-rw-r--r--content/en/commands/hugo_gen_doc.md4
-rw-r--r--content/en/commands/hugo_gen_man.md4
-rw-r--r--content/en/commands/hugo_import.md4
-rw-r--r--content/en/commands/hugo_import_jekyll.md4
-rw-r--r--content/en/commands/hugo_list.md4
-rw-r--r--content/en/commands/hugo_list_drafts.md4
-rw-r--r--content/en/commands/hugo_list_expired.md4
-rw-r--r--content/en/commands/hugo_list_future.md4
-rw-r--r--content/en/commands/hugo_new.md6
-rw-r--r--content/en/commands/hugo_new_site.md4
-rw-r--r--content/en/commands/hugo_new_theme.md4
-rw-r--r--content/en/commands/hugo_server.md6
-rw-r--r--content/en/commands/hugo_version.md4
-rw-r--r--content/en/content-management/archetypes.md4
-rw-r--r--content/en/content-management/cross-references.md2
-rw-r--r--content/en/content-management/menus.md2
-rw-r--r--content/en/content-management/organization/index.md14
-rw-r--r--content/en/content-management/page-resources.md2
-rw-r--r--content/en/content-management/static-files.md2
-rw-r--r--content/en/content-management/taxonomies.md2
-rw-r--r--content/en/content-management/toc.md4
-rw-r--r--content/en/content-management/urls.md26
-rw-r--r--content/en/contribute/documentation.md4
-rw-r--r--content/en/functions/apply.md10
-rw-r--r--content/en/functions/first.md29
-rw-r--r--content/en/functions/len.md5
-rw-r--r--content/en/functions/transform.Unmarshal.md11
-rw-r--r--content/en/functions/where.md36
-rw-r--r--content/en/getting-started/code-toggle.md4
-rw-r--r--content/en/getting-started/configuration.md49
-rw-r--r--content/en/getting-started/directory-structure.md10
-rw-r--r--content/en/getting-started/quick-start.md29
-rw-r--r--content/en/hosting-and-deployment/deployment-with-rsync.md4
-rw-r--r--content/en/hosting-and-deployment/hosting-on-bitbucket.md2
-rw-r--r--content/en/hosting-and-deployment/hosting-on-gitlab.md2
-rw-r--r--content/en/hosting-and-deployment/hosting-on-netlify.md4
-rw-r--r--content/en/templates/base.md16
-rw-r--r--content/en/templates/data-templates.md2
-rw-r--r--content/en/templates/lists.md69
-rw-r--r--content/en/templates/ordering-and-grouping.md41
-rw-r--r--content/en/templates/pagination.md4
-rw-r--r--content/en/templates/single-page-templates.md4
-rw-r--r--content/en/templates/taxonomy-templates.md2
-rw-r--r--content/en/templates/views.md4
-rw-r--r--content/en/themes/creating.md5
-rw-r--r--content/en/tools/editors.md2
-rw-r--r--content/en/troubleshooting/build-performance.md6
-rw-r--r--content/en/variables/hugo.md5
-rw-r--r--content/en/variables/page.md8
-rw-r--r--content/en/variables/site.md6
-rw-r--r--content/zh/templates/base.md16
-rw-r--r--data/docs.json109
-rw-r--r--resources/_gen/assets/css/output/css/app.css_d11fe7b62c27961c87ecd0f2490357b9.content2
-rw-r--r--resources/_gen/assets/css/output/css/app.css_d11fe7b62c27961c87ecd0f2490357b9.json2
-rw-r--r--themes/gohugoioTheme/assets/css/_algolia.css11
-rw-r--r--themes/gohugoioTheme/assets/output/css/app.css44
-rw-r--r--themes/gohugoioTheme/layouts/_default/baseof.html8
-rw-r--r--themes/gohugoioTheme/layouts/index.headers26
-rw-r--r--themes/gohugoioTheme/layouts/partials/home-page-sections/sponsors.html4
-rw-r--r--themes/gohugoioTheme/layouts/partials/site-search.html2
-rw-r--r--themes/gohugoioTheme/src/package-lock.json5747
-rw-r--r--themes/gohugoioTheme/src/package.json36
-rw-r--r--themes/gohugoioTheme/static/dist/app.bundle.js22
-rw-r--r--themes/gohugoioTheme/static/dist/main.css1
79 files changed, 6251 insertions, 391 deletions
diff --git a/.github/stale.yml b/.github/stale.yml
index f10747618..389205294 100644
--- a/.github/stale.yml
+++ b/.github/stale.yml
@@ -6,6 +6,7 @@ daysUntilClose: 30
exemptLabels:
- Keep
- Security
+ - UndocumentedFeature
# Label to use when marking an issue as stale
staleLabel: Stale
# Comment to post when marking an issue as stale. Set to `false` to disable
diff --git a/README.md b/README.md
index 23c4a6f55..70908ef12 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,5 @@
+[![Netlify Status](https://api.netlify.com/api/v1/badges/e0dbbfc7-34f1-4393-a679-c16e80162705/deploy-status)](https://app.netlify.com/sites/gohugoio/deploys)
+
# Hugo Docs
Documentation site for [Hugo](https://github.com/gohugoio/hugo), the very fast and flexible static site generator built with love in Go.
diff --git a/content/en/commands/hugo.md b/content/en/commands/hugo.md
index 67880f954..70cb53c29 100644
--- a/content/en/commands/hugo.md
+++ b/content/en/commands/hugo.md
@@ -1,5 +1,5 @@
---
-date: 2018-12-23
+date: 2019-01-30
title: "hugo"
slug: hugo
url: /commands/hugo/
@@ -55,7 +55,7 @@ hugo [flags]
--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/)
+ -t, --theme strings themes to use (located in /themes/THEMENAME/)
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
--verboseLog verbose logging
@@ -75,4 +75,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 23-Dec-2018
+###### Auto generated by spf13/cobra on 30-Jan-2019
diff --git a/content/en/commands/hugo_benchmark.md b/content/en/commands/hugo_benchmark.md
deleted file mode 100644
index e1afe9f7b..000000000
--- a/content/en/commands/hugo_benchmark.md
+++ /dev/null
@@ -1,72 +0,0 @@
----
-date: 2018-12-12
-title: "hugo benchmark"
-slug: hugo_benchmark
-url: /commands/hugo_benchmark/
----
-## hugo benchmark
-
-Benchmark Hugo by building a site a number of times.
-
-### Synopsis
-
-Hugo can build a site many times over and analyze the running process
-creating a benchmark.
-
-```
-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/
- --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
- -e, --environment string build environment
- --forceSyncStatic copy all files when static is changed.
- --gc enable to run some cleanup tasks (remove unused cache files) after the build
- -h, --help help for 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
- --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
- --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
-```
-
-### Options inherited from parent commands
-
-```
- --config string config file (default is path/config.yaml|json|toml)
- --configDir string config dir (default "config")
- --debug debug output
- --log enable Logging
- --logFile string log File path (if set, logging enabled automatically)
- --quiet build in quiet mode
- -v, --verbose verbose output
- --verboseLog verbose logging
-```
-
-### SEE ALSO
-
-* [hugo](/commands/hugo/) - hugo builds your site
-
-###### Auto generated by spf13/cobra on 12-Dec-2018
diff --git a/content/en/commands/hugo_check.md b/content/en/commands/hugo_check.md
index 7318cb4b5..4e649fb56 100644
--- a/content/en/commands/hugo_check.md
+++ b/content/en/commands/hugo_check.md
@@ -1,5 +1,5 @@
---
-date: 2018-12-23
+date: 2019-01-30
title: "hugo check"
slug: hugo_check
url: /commands/hugo_check/
@@ -36,4 +36,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 23-Dec-2018
+###### Auto generated by spf13/cobra on 30-Jan-2019
diff --git a/content/en/commands/hugo_check_ulimit.md b/content/en/commands/hugo_check_ulimit.md
index 7e0373206..185ef310f 100644
--- a/content/en/commands/hugo_check_ulimit.md
+++ b/content/en/commands/hugo_check_ulimit.md
@@ -1,5 +1,5 @@
---
-date: 2018-12-23
+date: 2019-01-30
title: "hugo check ulimit"
slug: hugo_check_ulimit
url: /commands/hugo_check_ulimit/
@@ -40,4 +40,4 @@ hugo check ulimit [flags]
* [hugo check](/commands/hugo_check/) - Contains some verification checks
-###### Auto generated by spf13/cobra on 23-Dec-2018
+###### Auto generated by spf13/cobra on 30-Jan-2019
diff --git a/content/en/commands/hugo_config.md b/content/en/commands/hugo_config.md
index b0970ecd9..c488cc7e0 100644
--- a/content/en/commands/hugo_config.md
+++ b/content/en/commands/hugo_config.md
@@ -1,5 +1,5 @@
---
-date: 2018-12-23
+date: 2019-01-30
title: "hugo config"
slug: hugo_config
url: /commands/hugo_config/
@@ -40,4 +40,4 @@ hugo config [flags]
* [hugo](/commands/hugo/) - hugo builds your site
-###### Auto generated by spf13/cobra on 23-Dec-2018
+###### Auto generated by spf13/cobra on 30-Jan-2019
diff --git a/content/en/commands/hugo_convert.md b/content/en/commands/hugo_convert.md
index eb826be45..7f95c3675 100644
--- a/content/en/commands/hugo_convert.md
+++ b/content/en/commands/hugo_convert.md
@@ -1,5 +1,5 @@
---
-date: 2018-12-23
+date: 2019-01-30
title: "hugo convert"
slug: hugo_convert
url: /commands/hugo_convert/
@@ -43,4 +43,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 23-Dec-2018
+###### Auto generated by spf13/cobra on 30-Jan-2019
diff --git a/content/en/comma