From 8d9511a08f14260cbfb73119e4afae50e5a9966d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B8rn=20Erik=20Pedersen?= Date: Wed, 8 Dec 2021 08:42:31 +0100 Subject: [PATCH] Squashed 'docs/' changes from 39a7fac34..316cec249 316cec249 Update future events template example (#1595) 3bde7d489 Install mage outside module (#1592) 762e27eff Clarify ignoreFiles regex matching 4d0032051 Add id attribute to h2 elements (#1590) 8262b077c Improve inline resource examples (#1587) 2eae7c7ec fix disqus example name (#1588) a772f4804 Added install instructions for openSUSE Tumbleweed (#1459) 7ad1c301b Remove screen capture from Hosting on GitHub page (#1586) a58541f49 add more details on about gh-pages and baseURL on hosting-on-github.md (#1346) 3bd0b46dc Update configuration page (#1585) 4cf1f013e Update OS functions 2c45a95c2 Remove getting-started/code-toggle/ 40fdff598 Describe artificial language private use subtags (#1577) 91011d210 Remove google_news from list of internal templates (#1576) 36c7879e4 Update the .Unix function 731063488 Remove a showcase 818c371a0 Update index.md 3136d39d9 netlify: Hugo 0.89.4 092bc9278 Merge branch 'tempv0.89.4' 18e01f105 releaser: Add release notes to /docs for release of 0.89.4 79135281f Correct and sort list of target image formats (#1574) af4170c7e netlify: Hugo 0.89.3 7f5444251 Merge branch 'tempv0.89.3' a32e4a6c2 releaser: Add release notes to /docs for release of 0.89.3 6dd3dc3f9 Update configuration.md 5fbe741d7 Update index.md (#1570) 37a69496f netlify: Bump to Hugo 0.89.2 3b293f1f4 Merge branch 'tempv0.89.2' 64c934e7a releaser: Add release notes to /docs for release of 0.89.2 919c51c7d Update index.md 13dd463b1 netlify: Hugo 0.89.1 d8cda1474 releaser: Add release notes to /docs for release of 0.89.1 a2adf7742 releaser: Add release notes to /docs for release of 0.89.1 c3088c4fc Add code toggle to menus page (#1568) 2d0f38978 Remove blank lines from code-toggle output (#1564) 7cf058bfd Add localization examples (#1563) cf8627c2e Fixing typos, fixing incomplete link (#1561) c78cc014b Document the removePathAccents setting 70beddaf4 Make corrections to 0.89.0 release notes (#1560) 1917195f0 Update index.md 7fb8e070c Run hugo --gc 1772d45fb Release 0.89.0 d9006179b Merge branch 'tempv0.89.0' 8db86b61e releaser: Add release notes to /docs for release of 0.89.0 abf268571 docs: Regen CLI docs fbbdb0ab1 Update the timeout default 9cbd1c15a Fix description of lang.FormatNumberCustom 6043b54cc Remove "render" keyword from Host on Render page f8ea8e84f Clarify description of front matter url (#1557) 91a0c9954 Update Twitter shortcode oEmbed endpoint 79a7405b8 Merge commit 'aa5ac36a3eb68b86c803caec703869efefc8447e' 57667bae6 hugofs: Add includeFiles and excludeFiles to mount configuration 0c9ee0a04 Allow multiple plugins in the PostCSS options map 155799e6b docs: Create path.Clean documentation git-subtree-dir: docs git-subtree-split: 316cec2494dc5f908283289371d74f36a73d3d8d --- content/en/commands/hugo_gen_chromastyles.md | 6 +- content/en/content-management/front-matter.md | 11 +- .../image-processing/index.md | 2 +- content/en/content-management/menus.md | 24 +- content/en/content-management/multilingual.md | 209 ++++++++++++------ .../content-management/organization/index.md | 38 ++-- .../en/content-management/page-resources.md | 17 +- content/en/content-management/related.md | 2 +- content/en/content-management/shortcodes.md | 10 +- content/en/contribute/development.md | 2 +- content/en/functions/GetPage.md | 4 +- content/en/functions/dict.md | 2 +- content/en/functions/fileExists.md | 34 ++- content/en/functions/getenv.md | 37 +++- content/en/functions/os.Stat.md | 28 +-- content/en/functions/path.Clean.md | 26 +++ content/en/functions/readdir.md | 43 +++- content/en/functions/readfile.md | 33 ++- content/en/functions/substr.md | 2 +- content/en/functions/unix.md | 38 ++-- content/en/getting-started/code-toggle.md | 79 ------- content/en/getting-started/configuration.md | 45 +++- content/en/getting-started/installing.md | 8 + .../hosting-on-github.md | 8 + .../hosting-on-render.md | 2 +- content/en/hugo-modules/configuration.md | 12 + content/en/hugo-pipes/postcss.md | 11 +- content/en/news/0.89.0-relnotes/featured.png | Bin 0 -> 104046 bytes content/en/news/0.89.0-relnotes/index.md | 106 +++++++++ content/en/news/0.89.1-relnotes/index.md | 20 ++ content/en/news/0.89.2-relnotes/index.md | 20 ++ content/en/news/0.89.3-relnotes/index.md | 26 +++ content/en/news/0.89.4-relnotes/index.md | 19 ++ content/en/showcase/aether/bio.md | 9 - content/en/showcase/aether/featured.png | Bin 275219 -> 0 bytes content/en/showcase/aether/index.md | 39 ---- content/en/showcase/arolla-cocoon/bio.md | 6 - .../arolla-cocoon/featured-template.png | Bin 451984 -> 0 bytes content/en/showcase/arolla-cocoon/index.md | 29 --- content/en/showcase/letsencrypt/index.md | 2 +- .../showcase/pace-revenue-management/bio.md | 4 - .../pace-revenue-management/featured.png | Bin 298908 -> 0 bytes .../showcase/pace-revenue-management/index.md | 28 --- content/en/templates/internal.md | 3 +- content/en/templates/introduction.md | 99 +++++---- content/en/troubleshooting/faq.md | 2 +- content/en/variables/site.md | 2 +- data/docs.json | 65 +++++- layouts/shortcodes/code-toggle.html | 4 +- layouts/template-func/page.html | 5 +- netlify.toml | 8 +- ...4914a5_75588_640x0_resize_catmullrom_3.png | Bin 48752 -> 0 bytes ...4e42f9_79436_640x0_resize_catmullrom_3.png | Bin 49168 -> 0 bytes ...46d71c_65337_640x0_resize_catmullrom_3.png | Bin 41701 -> 0 bytes ...2c5e7_104046_480x0_resize_catmullrom_3.png | Bin 0 -> 23201 bytes ...2c5e7_104046_640x0_resize_catmullrom_3.png | Bin 0 -> 39069 bytes ..._275219_1024x512_fill_catmullrom_top_3.png | Bin 148835 -> 0 bytes ...75219_f479f94112f3e0c5767e1193b5965779.png | Bin 49211 -> 0 bytes ...51984_0f50711b225daa7061d1303818804a06.png | Bin 67772 -> 0 bytes ..._451984_1024x512_fill_catmullrom_top_3.png | Bin 227292 -> 0 bytes 60 files changed, 762 insertions(+), 467 deletions(-) create mode 100644 content/en/functions/path.Clean.md delete mode 100644 content/en/getting-started/code-toggle.md create mode 100644 content/en/news/0.89.0-relnotes/featured.png create mode 100644 content/en/news/0.89.0-relnotes/index.md create mode 100644 content/en/news/0.89.1-relnotes/index.md create mode 100644 content/en/news/0.89.2-relnotes/index.md create mode 100644 content/en/news/0.89.3-relnotes/index.md create mode 100644 content/en/news/0.89.4-relnotes/index.md delete mode 100644 content/en/showcase/aether/bio.md delete mode 100644 content/en/showcase/aether/featured.png delete mode 100644 content/en/showcase/aether/index.md delete mode 100644 content/en/showcase/arolla-cocoon/bio.md delete mode 100644 content/en/showcase/arolla-cocoon/featured-template.png delete mode 100644 content/en/showcase/arolla-cocoon/index.md delete mode 100644 content/en/showcase/pace-revenue-management/bio.md delete mode 100644 content/en/showcase/pace-revenue-management/featured.png delete mode 100644 content/en/showcase/pace-revenue-management/index.md delete mode 100644 resources/_gen/images/news/0.66.0-relnotes/hugo-66-poster-featured_hu4d3a62a6d2ad42dd03e2a3723d4914a5_75588_640x0_resize_catmullrom_3.png delete mode 100644 resources/_gen/images/news/0.67.0-relnotes/hugo-67-poster-featured_hub9adb3c2f94f651d39a760315e4e42f9_79436_640x0_resize_catmullrom_3.png delete mode 100644 resources/_gen/images/news/0.68.0-relnotes/hugo-68-featured_hubf411be7de0d7016f242fc7f0c46d71c_65337_640x0_resize_catmullrom_3.png create mode 100644 resources/_gen/images/news/0.89.0-relnotes/featured_hu8f869189eb2dd98af38fbcfa6bc2c5e7_104046_480x0_resize_catmullrom_3.png create mode 100644 resources/_gen/images/news/0.89.0-relnotes/featured_hu8f869189eb2dd98af38fbcfa6bc2c5e7_104046_640x0_resize_catmullrom_3.png delete mode 100644 resources/_gen/images/showcase/aether/featured_hu087b0e6f87446792599d3d3535cdd374_275219_1024x512_fill_catmullrom_top_3.png delete mode 100644 resources/_gen/images/showcase/aether/featured_hu087b0e6f87446792599d3d3535cdd374_275219_f479f94112f3e0c5767e1193b5965779.png delete mode 100644 resources/_gen/images/showcase/arolla-cocoon/featured-template_hu22aab819ab27e4f878d1ff0b7cf78050_451984_0f50711b225daa7061d1303818804a06.png delete mode 100644 resources/_gen/images/showcase/arolla-cocoon/featured-template_hu22aab819ab27e4f878d1ff0b7cf78050_451984_1024x512_fill_catmullrom_top_3.png diff --git a/content/en/commands/hugo_gen_chromastyles.md b/content/en/commands/hugo_gen_chromastyles.md index e7b58bf03..2c24abca7 100644 --- a/content/en/commands/hugo_gen_chromastyles.md +++ b/content/en/commands/hugo_gen_chromastyles.md @@ -9,9 +9,9 @@ Generate CSS stylesheet for the Chroma code highlighter ### Synopsis -Generate CSS stylesheet for the Chroma code highlighter for a given style. This stylesheet is needed if pygmentsUseClasses is enabled in config. +Generate CSS stylesheet for the Chroma code highlighter for a given style. This stylesheet is needed if markup.highlight.noClasses is disabled in config. -See https://help.farbox.com/pygments.html for preview of available styles +See https://xyproto.github.io/splash/docs/all.html for a preview of the available styles ``` hugo gen chromastyles [flags] @@ -23,7 +23,7 @@ hugo gen chromastyles [flags] -h, --help help for chromastyles --highlightStyle string style used for highlighting lines (see https://github.com/alecthomas/chroma) (default "bg:#ffffcc") --linesStyle string style used for line numbers (see https://github.com/alecthomas/chroma) - --style string highlighter style (see https://help.farbox.com/pygments.html) (default "friendly") + --style string highlighter style (see https://xyproto.github.io/splash/docs/) (default "friendly") ``` ### Options inherited from parent commands diff --git a/content/en/content-management/front-matter.md b/content/en/content-management/front-matter.md index 0353fb1fe..2155f1992 100644 --- a/content/en/content-management/front-matter.md +++ b/content/en/content-management/front-matter.md @@ -65,7 +65,7 @@ audio : an array of paths to audio files related to the page; used by the `opengraph` [internal template](/templates/internal) to populate `og:audio`. cascade -: a map of Front Matter keys whose values are passed down to the page's descendents unless overwritten by self or a closer ancestor's cascade. See [Front Matter Cascade](#front-matter-cascade) for details. +: a map of Front Matter keys whose values are passed down to the page's descendants unless overwritten by self or a closer ancestor's cascade. See [Front Matter Cascade](#front-matter-cascade) for details. date : the datetime assigned to this page. This is usually fetched from the `date` field in front matter, but this behaviour is configurable. @@ -128,8 +128,7 @@ type : the type of the content; this value will be automatically derived from the directory (i.e., the [section][]) if not specified in front matter. url -: the full path to the content from the web root. It makes no assumptions about the path of the content file. It also ignores any language prefixes of -the multilingual feature. +: the full path to the content from the web root. It makes no assumptions about the path of the content file. See [URL Management](/content-management/urls/#set-url-in-front-matter). videos : an array of paths to videos related to the page; used by the `opengraph` [internal template](/templates/internal) to populate `og:video`. @@ -157,7 +156,7 @@ show_comments: false ## Front Matter Cascade -Any node or section can pass down to descendents a set of Front Matter values as long as defined underneath the reserved `cascade` Front Matter key. +Any node or section can pass down to descendants a set of Front Matter values as long as defined underneath the reserved `cascade` Front Matter key. ### Target Specific Pages @@ -202,9 +201,9 @@ cascade: banner: images/typewriter.jpg {{}} -With the above example the Blog section page and its descendents will return `images/typewriter.jpg` when `.Params.banner` is invoked unless: +With the above example the Blog section page and its descendants will return `images/typewriter.jpg` when `.Params.banner` is invoked unless: -- Said descendent has its own `banner` value set +- Said descendant has its own `banner` value set - Or a closer ancestor node has its own `cascade.banner` value set. diff --git a/content/en/content-management/image-processing/index.md b/content/en/content-management/image-processing/index.md index e2e964154..8f84145ac 100644 --- a/content/en/content-management/image-processing/index.md +++ b/content/en/content-management/image-processing/index.md @@ -229,7 +229,7 @@ See https://github.com/disintegration/imaging for more. If you want to trade qua By default the images is encoded in the source format, but you can set the target format as an option. -Valid values are `jpg`, `png`, `tif`, `bmp`, `gif` and `webp`. +Valid values are `bmp`, `gif`, `jpeg`, `jpg`, `png`, `tif`, `tiff`, and `webp`. ```go {{ $image.Resize "600x jpg" }} diff --git a/content/en/content-management/menus.md b/content/en/content-management/menus.md index 6b89c44da..aefc99e00 100644 --- a/content/en/content-management/menus.md +++ b/content/en/content-management/menus.md @@ -12,7 +12,7 @@ menu: docs: parent: "content-management" weight: 120 -weight: 120 #rem +weight: 120 aliases: [/extras/menus/] toc: true --- @@ -48,31 +48,24 @@ If all you need to do is add an entry to a menu, the simple form works well. #### A Single Menu -``` ---- +{{< code-toggle >}} menu: "main" ---- -``` +{{< /code-toggle >}} #### Multiple Menus -``` ---- +{{< code-toggle >}} menu: ["main", "footer"] ---- -``` +{{< /code-toggle >}} #### Advanced - -``` ---- +{{< code-toggle >}} menu: docs: parent: 'extras' weight: 20 ---- -``` +{{< /code-toggle >}} ## Add Non-content Entries to a Menu @@ -115,7 +108,7 @@ In this example, the top level of the menu is defined in your [site `config` fil ## Params -You can also add user-defined content to menu items via the `params` field. +You can also add user-defined content to menu items via the `params` field. A common use case is to define a custom param to add a css class to a specific menu item. @@ -130,7 +123,6 @@ A common use case is to define a custom param to add a css class to a specific m class = "highlight-menu-item" {{}} - ## Render Menus See [Menu Templates](/templates/menu-templates/) for information on how to render your site menus within your templates. diff --git a/content/en/content-management/multilingual.md b/content/en/content-management/multilingual.md index 5e7bed87c..c24c0ccc4 100644 --- a/content/en/content-management/multilingual.md +++ b/content/en/content-management/multilingual.md @@ -19,7 +19,7 @@ toc: true You should define the available languages in a `languages` section in your site configuration. -> Also See [Hugo Multilingual Part 1: Content translation](https://regisphilibert.com/blog/2018/08/hugo-multilingual-part-1-managing-content-translation/) +> Also See [Hugo Multilingual Part 1: Content translation] ## Configure Languages @@ -63,7 +63,7 @@ Anything not defined in a `languages` block will fall back to the global value f With the configuration above, all content, sitemap, RSS feeds, paginations, and taxonomy pages will be rendered below `/` in English (your default content language) and then below `/fr` in French. -When working with front matter `Params` in [single page templates][singles], omit the `params` in the key for the translation. +When working with front matter `Params` in [single page templates], omit the `params` in the key for the translation. `defaultContentLanguage` sets the project's default language. If not set, the default language will be `en`. @@ -83,25 +83,24 @@ disableLanguages = ["fr", "ja"] Note that you cannot disable the default content language. -We kept this as a standalone setting to make it easier to set via [OS environment](/getting-started/configuration/#configure-with-environment-variables): +We kept this as a standalone setting to make it easier to set via [OS environment]: ```bash HUGO_DISABLELANGUAGES="fr ja" hugo ``` + If you have already a list of disabled languages in `config.toml`, you can enable them in development like this: ```bash HUGO_DISABLELANGUAGES=" " hugo server ``` - ### Configure Multilingual Multihost From **Hugo 0.31** we support multiple languages in a multihost configuration. See [this issue](https://github.com/gohugoio/hugo/issues/4027) for details. This means that you can now configure a `baseURL` per `language`: - > If a `baseURL` is set on the `language` level, then all languages must have one and they must all be different. Example: @@ -123,7 +122,7 @@ title = "In English" With the above, the two sites will be generated into `public` with their own root: -```bash +```text public ├── en └── fr @@ -133,7 +132,7 @@ public When you run `hugo server` we will start multiple HTTP servers. You will typically see something like this in the console: -```bash +```text Web Server is available at 127.0.0.1:1313 (bind address 127.0.0.1) Web Server is available at 127.0.0.1:1314 (bind address 127.0.0.1) Press Ctrl+C to stop @@ -145,7 +144,6 @@ Live reload and `--navigateToChanged` between the servers work as expected. Taxonomies and [Blackfriday configuration][config] can also be set per language: - {{< code-toggle file="config" >}} [Taxonomies] tag = "tags" @@ -182,7 +180,7 @@ Considering the following example: The first file is assigned the English language and is linked to the second. The second file is assigned the French language and is linked to the first. -Their language is __assigned__ according to the language code added as a __suffix to the filename__. +Their language is __assigned__ according to the language code added as a __suffix to the filename__. By having the same **path and base filename**, the content pieces are __linked__ together as translated pages. @@ -195,7 +193,6 @@ If a file has no language code, it will be assigned the default language. This system uses different content directories for each of the languages. Each language's content directory is set using the `contentDir` param. {{< code-toggle file="config" >}} - languages: en: weight: 10 @@ -205,7 +202,6 @@ languages: weight: 20 languageName: "Français" contentDir: "content/french" - {{< /code-toggle >}} The value of `contentDir` can be any valid path -- even absolute path references. The only restriction is that the content directories cannot overlap. @@ -222,7 +218,7 @@ Their language is __assigned__ according to the content directory they are __pla By having the same **path and basename** (relative to their language content directory), the content pieces are __linked__ together as translated pages. -### Bypassing default linking. +### Bypassing default linking Any pages sharing the same `translationKey` set in front matter will be linked as translated pages regardless of basename or location. @@ -232,19 +228,17 @@ Considering the following example: 2. `/content/om.nn.md` 3. `/content/presentation/a-propos.fr.md` -```yaml -# set in all three pages +{{< code-toggle >}} translationKey: "about" -``` +{{< /code-toggle >}} By setting the `translationKey` front matter param to `about` in all three pages, they will be __linked__ as translated pages. - ### Localizing permalinks Because paths and filenames are used to handle linking, all translated pages will share the same URL (apart from the language subdirectory). -To localize the URLs, the [`slug`]({{< ref "/content-management/organization/index.md#slug" >}}) or [`url`]({{< ref "/content-management/organization/index.md#url" >}}) front matter param can be set in any of the non-default language file. +To localize the URLs, the [`slug`]({{< ref "/content-management/organization/index.md#slug" >}}) or [`url`]({{< ref "/content-management/organization/index.md#url" >}}) front matter param can be set in any of the non-default language file. For example, a French translation (`content/about.fr.md`) can have its own localized slug. @@ -253,7 +247,6 @@ Title: A Propos slug: "a-propos" {{< /code-toggle >}} - At render, Hugo will build both `/about/` and `/fr/a-propos/` while maintaining their translation linking. {{% note %}} @@ -283,16 +276,16 @@ To create a list of links to translated content, use a template similar to the f {{ if .IsTranslated }}

{{ i18n "translations" }}

{{ end }} {{< /code >}} -The above can be put in a `partial` (i.e., inside `layouts/partials/`) and included in any template, whether a [single content page][contenttemplate] or the [homepage][]. It will not print anything if there are no translations for a given page. +The above can be put in a `partial` (i.e., inside `layouts/partials/`) and included in any template, whether a [single content page][contenttemplate] or the [homepage]. It will not print anything if there are no translations for a given page. The above also uses the [`i18n` function][i18func] described in the next section. @@ -300,7 +293,6 @@ The above also uses the [`i18n` function][i18func] described in the next section `.AllTranslations` on a `Page` can be used to list all translations, including the page itself. On the home page it can be used to build a language navigator: - {{< code file="layouts/partials/allLanguages.html" >}}