From 90dcde60ee3d116355caef1fdd8106b06695250e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=B6ren=20Weber?= Date: Sat, 10 Jun 2023 00:14:46 +0200 Subject: [PATCH] docs: use _ consistantly for italics --- exampleSite/content/basics/customization/_index.en.md | 2 +- exampleSite/content/basics/migration/_index.en.md | 4 ++-- exampleSite/content/cont/i18n/_index.en.md | 4 ++-- exampleSite/content/cont/pages/_index.en.md | 4 ++-- exampleSite/content/cont/taxonomy.en.md | 2 +- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/exampleSite/content/basics/customization/_index.en.md b/exampleSite/content/basics/customization/_index.en.md index fe410796e8..82b1818353 100644 --- a/exampleSite/content/basics/customization/_index.en.md +++ b/exampleSite/content/basics/customization/_index.en.md @@ -33,7 +33,7 @@ This theme defines the following partials : ## Change the logo Create a new file in `layouts/partials/` named `logo.html`. Then write any HTML you want. -You could use an `img` HTML tag and reference an image created under the *static* folder, or you could paste a SVG definition! +You could use an `img` HTML tag and reference an image created under the _static_ folder, or you could paste a SVG definition! {{% notice note %}} The size of the logo will adapt automatically diff --git a/exampleSite/content/basics/migration/_index.en.md b/exampleSite/content/basics/migration/_index.en.md index ed45c3e3b2..afeb606bf6 100644 --- a/exampleSite/content/basics/migration/_index.en.md +++ b/exampleSite/content/basics/migration/_index.en.md @@ -411,7 +411,7 @@ This document shows you what's new in the latest release. For a detailed list of - {{% badge style="warning" title=" " %}}Breaking{{% /badge %}} We made changes to the menu footer. If you have your `menu-footer.html` [partial overridden]({{%relref "basics/customization" %}}), you may have to review the styling (eg. margins/paddings) in your partial. For a reference take a look into the `menu-footer.html` partial that is coming with the exampleSite. - This change was made to allow your own menu footer to be placed right after the so called prefooter that comes with the theme (containing the language switch and *Clear history* functionality). + This change was made to allow your own menu footer to be placed right after the so called prefooter that comes with the theme (containing the language switch and _Clear history_ functionality). - {{% badge style="warning" title=" " %}}Breaking{{% /badge %}} We have changed the default colors from the original Learn theme (the purple menu header) to the Relearn defaults (the light green menu header) as used in the official documentation. @@ -423,7 +423,7 @@ This document shows you what's new in the latest release. For a detailed list of - {{% badge style="note" title=" " %}}Change{{% /badge %}} For consistency reasons, we renamed `--MENU-SEARCH-BOX-color` to `--MENU-SEARCH-BORDER-color`. You don't need to change anything in your custom color stylesheet as the old name will be used as a fallback. -- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} With this release you are now capable to define your own *dark mode* variants. +- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} With this release you are now capable to define your own _dark mode_ variants. To make this possible, we have introduced a lot more color variables you can use in [your color variants]({{%relref "basics/customization/#theme-variant" %}}). Your old variants will still work and don't need to be changed as appropriate fallback values are used by the theme. Nevertheless, the new colors allow for much more customization. diff --git a/exampleSite/content/cont/i18n/_index.en.md b/exampleSite/content/cont/i18n/_index.en.md index 2955d8fcdc..e315ed7497 100644 --- a/exampleSite/content/cont/i18n/_index.en.md +++ b/exampleSite/content/cont/i18n/_index.en.md @@ -39,7 +39,7 @@ weight = 2 languageName = "Arrr! Pirrrates" ``` -Then, for each new page, append the *id* of the language to the file. +Then, for each new page, append the _id_ of the language to the file. - Single file `my-page.md` is split in two files: - in English: `my-page.md` @@ -86,7 +86,7 @@ Keep in mind that the language code required here, is the base language code. E. ## Overwrite translation strings -Translations strings are used for common default values used in the theme (*Edit* button, *Search placeholder* and so on). Translations are available in English and Piratized English but you may use another language or want to override default values. +Translations strings are used for common default values used in the theme (_Edit_ button, _Search placeholder_ and so on). Translations are available in English and Piratized English but you may use another language or want to override default values. To override these values, create a new file in your local i18n folder `i18n/.toml` and inspire yourself from the theme `themes/hugo-theme-relearn/i18n/en.toml` diff --git a/exampleSite/content/cont/pages/_index.en.md b/exampleSite/content/cont/pages/_index.en.md index 8e3682fe70..4e536a61b1 100644 --- a/exampleSite/content/cont/pages/_index.en.md +++ b/exampleSite/content/cont/pages/_index.en.md @@ -7,7 +7,7 @@ In **Hugo**, pages are the core of your site. Once it is configured, pages are d ## Folders -Organize your site like [any other Hugo project](https://gohugo.io/content/organization/). Typically, you will have a *content* folder with all your pages. +Organize your site like [any other Hugo project](https://gohugo.io/content/organization/). Typically, you will have a _content_ folder with all your pages. ````plaintext content @@ -53,7 +53,7 @@ The Relearn theme provides [archetypes]({{%relref "cont/archetypes" %}}) to help ## Frontmatter Configuration -Each Hugo page has to define a [frontmatter](https://gohugo.io/content/front-matter/) in *toml*, *yaml* or *json*. This site will use *toml* in all cases. +Each Hugo page has to define a [frontmatter](https://gohugo.io/content/front-matter/) in _toml_, _yaml_ or _json_. This site will use _toml_ in all cases. The Relearn theme uses the following parameters on top of Hugo ones: diff --git a/exampleSite/content/cont/taxonomy.en.md b/exampleSite/content/cont/taxonomy.en.md index a77ce680b2..7cdd6beeab 100644 --- a/exampleSite/content/cont/taxonomy.en.md +++ b/exampleSite/content/cont/taxonomy.en.md @@ -5,7 +5,7 @@ title = "Taxonomy" weight = 7 +++ -The Relearn theme supports Hugo's default taxonomies *tag* and *category* out of the box. +The Relearn theme supports Hugo's default taxonomies _tag_ and _category_ out of the box. ## Configuration