From 5e078383a787e8b5ec3ba73f05ea4130840afbe2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B8rn=20Erik=20Pedersen?= Date: Fri, 1 Feb 2019 09:01:04 +0100 Subject: [PATCH] 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 --- .github/stale.yml | 1 + README.md | 2 + content/en/commands/hugo.md | 6 +- content/en/commands/hugo_benchmark.md | 72 - content/en/commands/hugo_check.md | 4 +- content/en/commands/hugo_check_ulimit.md | 4 +- content/en/commands/hugo_config.md | 4 +- content/en/commands/hugo_convert.md | 4 +- content/en/commands/hugo_convert_toJSON.md | 4 +- content/en/commands/hugo_convert_toTOML.md | 4 +- content/en/commands/hugo_convert_toYAML.md | 4 +- content/en/commands/hugo_env.md | 4 +- content/en/commands/hugo_gen.md | 4 +- content/en/commands/hugo_gen_autocomplete.md | 4 +- content/en/commands/hugo_gen_chromastyles.md | 4 +- content/en/commands/hugo_gen_doc.md | 4 +- content/en/commands/hugo_gen_man.md | 4 +- content/en/commands/hugo_import.md | 4 +- content/en/commands/hugo_import_jekyll.md | 4 +- content/en/commands/hugo_list.md | 4 +- content/en/commands/hugo_list_drafts.md | 4 +- content/en/commands/hugo_list_expired.md | 4 +- content/en/commands/hugo_list_future.md | 4 +- content/en/commands/hugo_new.md | 6 +- content/en/commands/hugo_new_site.md | 4 +- content/en/commands/hugo_new_theme.md | 4 +- content/en/commands/hugo_server.md | 6 +- content/en/commands/hugo_version.md | 4 +- content/en/content-management/archetypes.md | 4 +- .../en/content-management/cross-references.md | 2 +- content/en/content-management/menus.md | 2 +- .../content-management/organization/index.md | 14 +- .../en/content-management/page-resources.md | 2 +- content/en/content-management/static-files.md | 2 +- content/en/content-management/taxonomies.md | 2 +- content/en/content-management/toc.md | 4 +- content/en/content-management/urls.md | 26 +- content/en/contribute/documentation.md | 4 +- content/en/functions/apply.md | 10 +- content/en/functions/first.md | 29 +- content/en/functions/len.md | 5 +- content/en/functions/transform.Unmarshal.md | 11 +- content/en/functions/where.md | 36 +- content/en/getting-started/code-toggle.md | 4 +- content/en/getting-started/configuration.md | 49 +- .../en/getting-started/directory-structure.md | 10 +- content/en/getting-started/quick-start.md | 29 +- .../deployment-with-rsync.md | 4 +- .../hosting-on-bitbucket.md | 2 +- .../hosting-on-gitlab.md | 2 +- .../hosting-on-netlify.md | 4 +- content/en/templates/base.md | 16 +- content/en/templates/data-templates.md | 2 +- content/en/templates/lists.md | 69 +- content/en/templates/ordering-and-grouping.md | 41 +- content/en/templates/pagination.md | 4 +- content/en/templates/single-page-templates.md | 4 +- content/en/templates/taxonomy-templates.md | 2 +- content/en/templates/views.md | 4 +- content/en/themes/creating.md | 5 +- content/en/tools/editors.md | 2 + .../en/troubleshooting/build-performance.md | 6 +- content/en/variables/hugo.md | 5 + content/en/variables/page.md | 8 +- content/en/variables/site.md | 6 - content/zh/templates/base.md | 16 +- data/docs.json | 109 +- ...s_d11fe7b62c27961c87ecd0f2490357b9.content | 2 +- ....css_d11fe7b62c27961c87ecd0f2490357b9.json | 2 +- themes/gohugoioTheme/assets/css/_algolia.css | 11 +- .../gohugoioTheme/assets/output/css/app.css | 44 +- .../layouts/_default/baseof.html | 8 +- themes/gohugoioTheme/layouts/index.headers | 26 +- .../partials/home-page-sections/sponsors.html | 4 +- .../layouts/partials/site-search.html | 2 +- themes/gohugoioTheme/src/package-lock.json | 5747 +++++++++++++++++ themes/gohugoioTheme/src/package.json | 36 + .../gohugoioTheme/static/dist/app.bundle.js | 22 + themes/gohugoioTheme/static/dist/main.css | 1 + 79 files changed, 6251 insertions(+), 391 deletions(-) delete mode 100644 content/en/commands/hugo_benchmark.md create mode 100644 themes/gohugoioTheme/src/package-lock.json create mode 100644 themes/gohugoioTheme/src/package.json create mode 100644 themes/gohugoioTheme/static/dist/app.bundle.js create mode 100644 themes/gohugoioTheme/static/dist/main.css 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/commands/hugo_convert_toJSON.md b/content/en/commands/hugo_convert_toJSON.md index fa079c047..a663177d7 100644 --- a/content/en/commands/hugo_convert_toJSON.md +++ b/content/en/commands/hugo_convert_toJSON.md @@ -1,5 +1,5 @@ --- -date: 2018-12-23 +date: 2019-01-30 title: "hugo convert toJSON" slug: hugo_convert_toJSON url: /commands/hugo_convert_tojson/ @@ -43,4 +43,4 @@ hugo convert toJSON [flags] * [hugo convert](/commands/hugo_convert/) - Convert your content to different formats -###### 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_toTOML.md b/content/en/commands/hugo_convert_toTOML.md index a0ad847fb..357376fcb 100644 --- a/content/en/commands/hugo_convert_toTOML.md +++ b/content/en/commands/hugo_convert_toTOML.md @@ -1,5 +1,5 @@ --- -date: 2018-12-23 +date: 2019-01-30 title: "hugo convert toTOML" slug: hugo_convert_toTOML url: /commands/hugo_convert_totoml/ @@ -43,4 +43,4 @@ hugo convert toTOML [flags] * [hugo convert](/commands/hugo_convert/) - Convert your content to different formats -###### 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_toYAML.md b/content/en/commands/hugo_convert_toYAML.md index 98372cf3d..c5352a719 100644 --- a/content/en/commands/hugo_convert_toYAML.md +++ b/content/en/commands/hugo_convert_toYAML.md @@ -1,5 +1,5 @@ --- -date: 2018-12-23 +date: 2019-01-30 title: "hugo convert toYAML" slug: hugo_convert_toYAML url: /commands/hugo_convert_toyaml/ @@ -43,4 +43,4 @@ hugo convert toYAML [flags] * [hugo convert](/commands/hugo_convert/) - Convert your content to different formats -###### 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_env.md b/content/en/commands/hugo_env.md index 0aed2f670..c801f1ae3 100644 --- a/content/en/commands/hugo_env.md +++ b/content/en/commands/hugo_env.md @@ -1,5 +1,5 @@ --- -date: 2018-12-23 +date: 2019-01-30 title: "hugo env" slug: hugo_env url: /commands/hugo_env/ @@ -39,4 +39,4 @@ hugo env [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_gen.md b/content/en/commands/hugo_gen.md index 930d33e74..364187d47 100644 --- a/content/en/commands/hugo_gen.md +++ b/content/en/commands/hugo_gen.md @@ -1,5 +1,5 @@ --- -date: 2018-12-23 +date: 2019-01-30 title: "hugo gen" slug: hugo_gen url: /commands/hugo_gen/ @@ -39,4 +39,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 23-Dec-2018 +###### Auto generated by spf13/cobra on 30-Jan-2019 diff --git a/content/en/commands/hugo_gen_autocomplete.md b/content/en/commands/hugo_gen_autocomplete.md index 9d4a78545..385b027c5 100644 --- a/content/en/commands/hugo_gen_autocomplete.md +++ b/content/en/commands/hugo_gen_autocomplete.md @@ -1,5 +1,5 @@ --- -date: 2018-12-23 +date: 2019-01-30 title: "hugo gen autocomplete" slug: hugo_gen_autocomplete url: /commands/hugo_gen_autocomplete/ @@ -57,4 +57,4 @@ hugo gen autocomplete [flags] * [hugo gen](/commands/hugo_gen/) - A collection of several useful generators. -###### 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_gen_chromastyles.md b/content/en/commands/hugo_gen_chromastyles.md index 3faca28fa..b939b30f7 100644 --- a/content/en/commands/hugo_gen_chromastyles.md +++ b/content/en/commands/hugo_gen_chromastyles.md @@ -1,5 +1,5 @@ --- -date: 2018-12-23 +date: 2019-01-30 title: "hugo gen chromastyles" slug: hugo_gen_chromastyles url: /commands/hugo_gen_chromastyles/ @@ -44,4 +44,4 @@ hugo gen chromastyles [flags] * [hugo gen](/commands/hugo_gen/) - A collection of several useful generators. -###### 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_gen_doc.md b/content/en/commands/hugo_gen_doc.md index 1308b9502..8c8516850 100644 --- a/content/en/commands/hugo_gen_doc.md +++ b/content/en/commands/hugo_gen_doc.md @@ -1,5 +1,5 @@ --- -date: 2018-12-23 +date: 2019-01-30 title: "hugo gen doc" slug: hugo_gen_doc url: /commands/hugo_gen_doc/ @@ -46,4 +46,4 @@ hugo gen doc [flags] * [hugo gen](/commands/hugo_gen/) - A collection of several useful generators. -###### 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_gen_man.md b/content/en/commands/hugo_gen_man.md index 205188699..bbe87178a 100644 --- a/content/en/commands/hugo_gen_man.md +++ b/content/en/commands/hugo_gen_man.md @@ -1,5 +1,5 @@ --- -date: 2018-12-23 +date: 2019-01-30 title: "hugo gen man" slug: hugo_gen_man url: /commands/hugo_gen_man/ @@ -42,4 +42,4 @@ hugo gen man [flags] * [hugo gen](/commands/hugo_gen/) - A collection of several useful generators. -###### 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_import.md b/content/en/commands/hugo_import.md index 8f84b7a23..473431836 100644 --- a/content/en/commands/hugo_import.md +++ b/content/en/commands/hugo_import.md @@ -1,5 +1,5 @@ --- -date: 2018-12-23 +date: 2019-01-30 title: "hugo import" slug: hugo_import url: /commands/hugo_import/ @@ -38,4 +38,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 23-Dec-2018 +###### Auto generated by spf13/cobra on 30-Jan-2019 diff --git a/content/en/commands/hugo_import_jekyll.md b/content/en/commands/hugo_import_jekyll.md index ca30e1855..f78fcd135 100644 --- a/content/en/commands/hugo_import_jekyll.md +++ b/content/en/commands/hugo_import_jekyll.md @@ -1,5 +1,5 @@ --- -date: 2018-12-23 +date: 2019-01-30 title: "hugo import jekyll" slug: hugo_import_jekyll url: /commands/hugo_import_jekyll/ @@ -42,4 +42,4 @@ hugo import jekyll [flags] * [hugo import](/commands/hugo_import/) - Import your site from others. -###### 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_list.md b/content/en/commands/hugo_list.md index 0d18aa278..de3cb7839 100644 --- a/content/en/commands/hugo_list.md +++ b/content/en/commands/hugo_list.md @@ -1,5 +1,5 @@ --- -date: 2018-12-23 +date: 2019-01-30 title: "hugo list" slug: hugo_list url: /commands/hugo_list/ @@ -41,4 +41,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 23-Dec-2018 +###### Auto generated by spf13/cobra on 30-Jan-2019 diff --git a/content/en/commands/hugo_list_drafts.md b/content/en/commands/hugo_list_drafts.md index 32f94bbd4..aa65e787d 100644 --- a/content/en/commands/hugo_list_drafts.md +++ b/content/en/commands/hugo_list_drafts.md @@ -1,5 +1,5 @@ --- -date: 2018-12-23 +date: 2019-01-30 title: "hugo list drafts" slug: hugo_list_drafts url: /commands/hugo_list_drafts/ @@ -40,4 +40,4 @@ hugo list drafts [flags] * [hugo list](/commands/hugo_list/) - Listing out various types of content -###### 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_list_expired.md b/content/en/commands/hugo_list_expired.md index 703711c3c..106e41df2 100644 --- a/content/en/commands/hugo_list_expired.md +++ b/content/en/commands/hugo_list_expired.md @@ -1,5 +1,5 @@ --- -date: 2018-12-23 +date: 2019-01-30 title: "hugo list expired" slug: hugo_list_expired url: /commands/hugo_list_expired/ @@ -41,4 +41,4 @@ hugo list expired [flags] * [hugo list](/commands/hugo_list/) - Listing out various types of content -###### 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_list_future.md b/content/en/commands/hugo_list_future.md index 6bfa3cf25..6e0c99857 100644 --- a/content/en/commands/hugo_list_future.md +++ b/content/en/commands/hugo_list_future.md @@ -1,5 +1,5 @@ --- -date: 2018-12-23 +date: 2019-01-30 title: "hugo list future" slug: hugo_list_future url: /commands/hugo_list_future/ @@ -41,4 +41,4 @@ hugo list future [flags] * [hugo list](/commands/hugo_list/) - Listing out various types of content -###### 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_new.md b/content/en/commands/hugo_new.md index 86adb91f4..cce7f4ecb 100644 --- a/content/en/commands/hugo_new.md +++ b/content/en/commands/hugo_new.md @@ -1,5 +1,5 @@ --- -date: 2018-12-23 +date: 2019-01-30 title: "hugo new" slug: hugo_new url: /commands/hugo_new/ @@ -52,7 +52,7 @@ hugo new [path] [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 ``` @@ -75,4 +75,4 @@ hugo new [path] [flags] * [hugo new site](/commands/hugo_new_site/) - Create a new site (skeleton) * [hugo new theme](/commands/hugo_new_theme/) - Create a new theme -###### 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_new_site.md b/content/en/commands/hugo_new_site.md index b3419e89d..4bb9cda50 100644 --- a/content/en/commands/hugo_new_site.md +++ b/content/en/commands/hugo_new_site.md @@ -1,5 +1,5 @@ --- -date: 2018-12-23 +date: 2019-01-30 title: "hugo new site" slug: hugo_new_site url: /commands/hugo_new_site/ @@ -44,4 +44,4 @@ hugo new site [path] [flags] * [hugo new](/commands/hugo_new/) - Create new content for 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_new_theme.md b/content/en/commands/hugo_new_theme.md index b6c91a13a..a49301928 100644 --- a/content/en/commands/hugo_new_theme.md +++ b/content/en/commands/hugo_new_theme.md @@ -1,5 +1,5 @@ --- -date: 2018-12-23 +date: 2019-01-30 title: "hugo new theme" slug: hugo_new_theme url: /commands/hugo_new_theme/ @@ -43,4 +43,4 @@ hugo new theme [name] [flags] * [hugo new](/commands/hugo_new/) - Create new content for 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_server.md b/content/en/commands/hugo_server.md index d4a42e160..501a5a99e 100644 --- a/content/en/commands/hugo_server.md +++ b/content/en/commands/hugo_server.md @@ -1,5 +1,5 @@ --- -date: 2018-12-23 +date: 2019-01-30 title: "hugo server" slug: hugo_server url: /commands/hugo_server/ @@ -66,7 +66,7 @@ hugo server [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 -w, --watch watch filesystem for changes and recreate as needed (default true) ``` @@ -88,4 +88,4 @@ hugo server [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_version.md b/content/en/commands/hugo_version.md index 4cc05e4e2..1b3d9080b 100644 --- a/content/en/commands/hugo_version.md +++ b/content/en/commands/hugo_version.md @@ -1,5 +1,5 @@ --- -date: 2018-12-23 +date: 2019-01-30 title: "hugo version" slug: hugo_version url: /commands/hugo_version/ @@ -39,4 +39,4 @@ hugo version [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/content-management/archetypes.md b/content/en/content-management/archetypes.md index 3fc8a9f3f..354ef0fef 100644 --- a/content/en/content-management/archetypes.md +++ b/content/en/content-management/archetypes.md @@ -85,10 +85,10 @@ archetypes ``` ```bash -hugo new --kind post-bundle post/my-post +hugo new --kind post-bundle posts/my-post ``` -Will create a new folder in `/content/post/my-post` with the same set of files as in the `post-bundle` archetypes folder. All content files (`index.md` etc.) can contain template logic, and will receive the correct `.Site` for the content's language. +Will create a new folder in `/content/posts/my-post` with the same set of files as in the `post-bundle` archetypes folder. All content files (`index.md` etc.) can contain template logic, and will receive the correct `.Site` for the content's language. diff --git a/content/en/content-management/cross-references.md b/content/en/content-management/cross-references.md index 59733555b..145c2d338 100644 --- a/content/en/content-management/cross-references.md +++ b/content/en/content-management/cross-references.md @@ -35,7 +35,7 @@ The single parameter to `ref` is a string with a content `documentname` (e.g., ` **Paths without a leading `/` will first be tried resolved relative to the current page.** -You will get an error if you document could not be uniquely resolved. The error behaviour can be configured, see below. +You will get an error if your document could not be uniquely resolved. The error behaviour can be configured, see below. ### Link to another language version diff --git a/content/en/content-management/menus.md b/content/en/content-management/menus.md index bc48c82e7..9ac6f8bff 100644 --- a/content/en/content-management/menus.md +++ b/content/en/content-management/menus.md @@ -111,7 +111,7 @@ The following order is used to determine an Identifier: This means that `.Title` will be used unless `.LinkTitle` is present, etc. In practice, `.Name` and `.Identifier` are only used to structure relationships and therefore never displayed. -In this example, the top level of the menu is defined in your [site `config` file][config]). All content entries are attached to one of these entries via the `.Parent` field. +In this example, the top level of the menu is defined in your [site `config` file][config]. All content entries are attached to one of these entries via the `.Parent` field. ## Render Menus diff --git a/content/en/content-management/organization/index.md b/content/en/content-management/organization/index.md index b1bc8b368..e9ae91b57 100644 --- a/content/en/content-management/organization/index.md +++ b/content/en/content-management/organization/index.md @@ -19,7 +19,7 @@ toc: true ## Page Bundles -Hugo `0.32` announced page-relative images and other resources packaged into `Page Bundles`. +Hugo `0.32` announced page-relative images and other resources packaged into `Page Bundles`. These terms are connected, and you also need to read about [Page Resources]({{< relref "/content-management/page-resources" >}}) and [Image Processing]({{< relref "/content-management/image-processing" >}}) to get the full picture. @@ -38,7 +38,7 @@ The bundle documentation is **work in progress**. We will publish more comprehen In Hugo, your content should be organized in a manner that reflects the rendered website. -While Hugo supports content nested at any level, the top levels (i.e. `content/`) are special in Hugo and are considered the content type used to determine layouts etc. To read more about sections, including how to nest them, see [sections][]. +While Hugo supports content nested at any level, the top levels (i.e. `content/`) are special in Hugo and are considered the content type used to determine layouts etc. To read more about sections, including how to nest them, see [sections][]. Without any additional configuration, the following will just work: @@ -47,11 +47,11 @@ Without any additional configuration, the following will just work: └── content └── about | └── _index.md // <- https://example.com/about/ - ├── post - | ├── firstpost.md // <- https://example.com/post/firstpost/ + ├── posts + | ├── firstpost.md // <- https://example.com/posts/firstpost/ | ├── happy - | | └── ness.md // <- https://example.com/post/happy/ness/ - | └── secondpost.md // <- https://example.com/post/secondpost/ + | | └── ness.md // <- https://example.com/posts/happy/ness/ + | └── secondpost.md // <- https://example.com/posts/secondpost/ └── quote ├── first.md // <- https://example.com/quote/first/ └── second.md // <- https://example.com/quote/second/ @@ -64,7 +64,7 @@ The following demonstrates the relationships between your content organization a ### Index Pages: `_index.md` -`_index.md` has a special role in Hugo. It allows you to add front matter and content to your [list templates][lists]. These templates include those for [section templates][], [taxonomy templates][], [taxonomy terms templates][], and your [homepage template][]. +`_index.md` has a special role in Hugo. It allows you to add front matter and content to your [list templates][lists]. These templates include those for [section templates][], [taxonomy templates][], [taxonomy terms templates][], and your [homepage template][]. {{% note %}} **Tip:** You can get a reference to the content and metadata in `_index.md` using the [`.Site.GetPage` function](/functions/getpage/). diff --git a/content/en/content-management/page-resources.md b/content/en/content-management/page-resources.md index c3c29e452..dcd19e42f 100644 --- a/content/en/content-management/page-resources.md +++ b/content/en/content-management/page-resources.md @@ -23,7 +23,7 @@ Name : Default value is the filename (relative to the owning page). Can be set in front matter. Title -: Default blank. Can be set in front matter. +: Default value is the same as `.Name`. Can be set in front matter. Permalink : The absolute URL to the resource. Resources of type `page` will have no value. diff --git a/content/en/content-management/static-files.md b/content/en/content-management/static-files.md index 8967f5983..e42ee9088 100644 --- a/content/en/content-management/static-files.md +++ b/content/en/content-management/static-files.md @@ -14,7 +14,7 @@ toc: true --- By default, the `static/` directory in the site project is used for -all **static files** (e.g. stylesheets, JavaScript, images). +all **static files** (e.g. stylesheets, JavaScript, images). The static files are served on the site root path (eg. if you have the file `static/image.png` you can access it using `http://{server-url}/image.png`, to include it in a document you can use `![Example image](/image.png) )`. Hugo can be configured to look into a different directory, or even **multiple directories** for such static files by configuring the diff --git a/content/en/content-management/taxonomies.md b/content/en/content-management/taxonomies.md index c06b2385b..7957bf29d 100644 --- a/content/en/content-management/taxonomies.md +++ b/content/en/content-management/taxonomies.md @@ -86,7 +86,7 @@ Moonrise Kingdom <- Value Hugo natively supports taxonomies. -Without adding a single line to your [site config][config] file, Hugo will automatically create taxonomies for `tags` and `categories`. That would be same as manually [configuring your taxonomies](#configuring-taxonomies) as below: +Without adding a single line to your [site config][config] file, Hugo will automatically create taxonomies for `tags` and `categories`. That would be the same as manually [configuring your taxonomies](#configuring-taxonomies) as below: {{< code-toggle copy="false" >}} [taxonomies] diff --git a/content/en/content-management/toc.md b/content/en/content-management/toc.md index a500bcf66..56f51049d 100644 --- a/content/en/content-management/toc.md +++ b/content/en/content-management/toc.md @@ -74,7 +74,7 @@ The following is an example of a very basic [single page template][]: The following is a [partial template][partials] that adds slightly more logic for page-level control over your table of contents. It assumes you are using a `toc` field in your content's [front matter][] that, unless specifically set to `false`, will add a TOC to any page with a `.WordCount` (see [Page Variables][pagevars]) greater than 400. This example also demonstrates how to use [conditionals][] in your templating: {{< code file="layouts/partials/toc.html" download="toc.html" >}} -{{ if and (gt .WordCount 400 ) (ne .Params.toc "false") }} +{{ if and (gt .WordCount 400 ) (.Params.toc) }}