docs: wording and typography #567

.github/actions/release_milestone/action.yaml

@@ -168,7 +168,7 @@ runs:
       with:
         value: ${{ steps.changelog_docs.outputs.contents }}
         regex: '(##\s+.*?[\n\r])[\n\r\s]*([\s\S]*)'
-        replacement: "[★ What’s new in this version ★](https://mcshelby.github.io/hugo-theme-relearn/basics/releasenotes/${{ steps.majorvers.outputs.value }}/${{ steps.minorvers.outputs.value }}/)\n\n$2"
+        replacement: "[★ What's new in this version ★](https://mcshelby.github.io/hugo-theme-relearn/basics/releasenotes/${{ steps.majorvers.outputs.value }}/${{ steps.minorvers.outputs.value }}/)\n\n$2"
 
     - name: Commit updates
       shell: bash

CHANGELOG.md

@@ -103,7 +103,7 @@
 - [**task**] theme: remove special cases for LanguageCode [#861](https://github.com/McShelby/hugo-theme-relearn/issues/861)
 - [**task**] link: adjust to Hugo's build-in code [#858](https://github.com/McShelby/hugo-theme-relearn/issues/858)
 - [**task**] image: adjust to Hugo's build-in code [#857](https://github.com/McShelby/hugo-theme-relearn/issues/857)
-- [**task**] opengraph: sync to Hugo’s implementation [#856](https://github.com/McShelby/hugo-theme-relearn/issues/856)
+- [**task**] opengraph: sync to Hugo's implementation [#856](https://github.com/McShelby/hugo-theme-relearn/issues/856)
 - [**task**] i18n: improve file naming [#848](https://github.com/McShelby/hugo-theme-relearn/issues/848)
 
 ---
@@ -1374,7 +1374,7 @@
 
 ### Fixes
 
-- [**bug**] favicon: fix URL if site resides in subfolder [#302](https://github.com/McShelby/hugo-theme-relearn/issues/302)
+- [**bug**] favicon: fix URL if site resides in subdirectory [#302](https://github.com/McShelby/hugo-theme-relearn/issues/302)
 - [**bug**] code: show copy-to-clipboard marker for blocklevel code [#298](https://github.com/McShelby/hugo-theme-relearn/issues/298)
 - [**bug**] menu: make active expander visible on hover [#297](https://github.com/McShelby/hugo-theme-relearn/issues/297)
 - [**bug**] print: disable arrow navigation [#294](https://github.com/McShelby/hugo-theme-relearn/issues/294)

exampleSite/content/basics/changelog/5/0/000.en.md

@@ -14,7 +14,7 @@
 
 ### Fixes
 
-- [**bug**] favicon: fix URL if site resides in subfolder [#302](https://github.com/McShelby/hugo-theme-relearn/issues/302)
+- [**bug**] favicon: fix URL if site resides in subdirectory [#302](https://github.com/McShelby/hugo-theme-relearn/issues/302)
 - [**bug**] code: show copy-to-clipboard marker for blocklevel code [#298](https://github.com/McShelby/hugo-theme-relearn/issues/298)
 - [**bug**] menu: make active expander visible on hover [#297](https://github.com/McShelby/hugo-theme-relearn/issues/297)
 - [**bug**] print: disable arrow navigation [#294](https://github.com/McShelby/hugo-theme-relearn/issues/294)

exampleSite/content/basics/changelog/6/1/000.en.md

@@ -25,5 +25,5 @@
 - [**task**] theme: remove special cases for LanguageCode [#861](https://github.com/McShelby/hugo-theme-relearn/issues/861)
 - [**task**] link: adjust to Hugo's build-in code [#858](https://github.com/McShelby/hugo-theme-relearn/issues/858)
 - [**task**] image: adjust to Hugo's build-in code [#857](https://github.com/McShelby/hugo-theme-relearn/issues/857)
-- [**task**] opengraph: sync to Hugo’s implementation [#856](https://github.com/McShelby/hugo-theme-relearn/issues/856)
+- [**task**] opengraph: sync to Hugo's implementation [#856](https://github.com/McShelby/hugo-theme-relearn/issues/856)
 - [**task**] i18n: improve file naming [#848](https://github.com/McShelby/hugo-theme-relearn/issues/848)

exampleSite/content/basics/releasenotes/2/6.en.md

@@ -10,4 +10,4 @@ weight = -6
 
 ### New
 
-- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} Your site can now be served from a subfolder if you set `baseURL` in your `hugo.toml`. See the [documentation](configuration/customization#public-web-server-from-subdirectory) for a detailed example.
+- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} Your site can now be served from a subdirectory if you set `baseURL` in your `hugo.toml`. See the [documentation](configuration/customization#public-web-server-from-subdirectory) for a detailed example.

exampleSite/content/basics/releasenotes/5/20.en.md

@@ -35,6 +35,6 @@ weight = -20
 
 - {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The default values for the [image effects](content/markdown#image-effects) are [now configurable](content/imageeffects) for your whole site via `hugo.toml` or for each page through frontmatter.
 
-- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} This release fixes a long unresolved bug where Mermaid graphs could not be displayed if they were initially hidden - like in collapsed `expand` or inactive `tabs`.
+- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} This release fixes a long-standing bug where Mermaid graphs could not be displayed if they were initially hidden - like in collapsed `expand` or inactive `tabs`.
 
 - {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} Restored compatibility with Hugo versions lower than {{% badge color="fuchsia" icon="fa-fw fab fa-hackerrank" title=" " %}}0.111.0{{% /badge %}} for the [`highlight` shortcode](shortcodes/highlight). This does not change the minimum required Hugo version.

exampleSite/content/basics/releasenotes/5/26.en.md

@@ -18,4 +18,4 @@ weight = -26
 
 - {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The theme has updated its Mermaid dependency to 10.6.0. This adds support for [block diagrams](shortcodes/mermaid#block-diagram).
 
-- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} This release fixes a long unresolved bug where the page wasn't repositioning correctly when going forward or backward in your browser history.
+- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} This release fixes a long-standing bug where the page wasn't repositioning correctly when going forward or backward in your browser history.

exampleSite/content/basics/releasenotes/5/9.en.md

@@ -43,7 +43,7 @@ weight = -9
 
 ### Change
 
-- {{% badge style="note" title=" " %}}Change{{% /badge %}} The required folder name for the [`attachments` shortcode](shortcodes/attachments) was changed for leaf bundles.
+- {{% badge style="note" title=" " %}}Change{{% /badge %}} The required directory name for the [`attachments` shortcode](shortcodes/attachments) was changed for leaf bundles.
 
   Previously, the attachments for leaf bundles in non-multilang setups were required to be in a `files` subdirectory. For page bundles and leaf bundles in multilang setups they were always required to be in a `_index.<LANGCODE>.files` or `index.<LANGCODE>.files` subdirectory accordingly.
 

exampleSite/content/basics/releasenotes/6/0.en.md

@@ -32,7 +32,7 @@ weight = -0
 
   Change it to `search` for the homepage in your `hugo.toml`. See the docs for [detailed configuration](configuration/customization#configure-search).
 
-- {{% badge style="warning" title=" " %}}Breaking{{% /badge %}} The frontmatter option `menuTitle` [deprecated in 5.24.0](basics/releasenotes/5/#5-24-0) was removed in favor for Hugo’s own `linkTitle`.
+- {{% badge style="warning" title=" " %}}Breaking{{% /badge %}} The frontmatter option `menuTitle` [deprecated in 5.24.0](basics/releasenotes/5/#5-24-0) was removed in favor for Hugo's own `linkTitle`.
 
   Additionally, if set, `linkTitle` will now be used instead of `title` to generate the breadcrumb.
 

exampleSite/content/configuration/branding/_index.en.md

@@ -82,7 +82,7 @@ If you need to change this default behavior, create a new file `layouts/partials
 
 ## Change the Logo
 
-Create a new file in `layouts/partials/logo.html` of your site. 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!
+Create a new file in `layouts/partials/logo.html` of your site. Then write any HTML you want. You could use an `img` HTML tag and reference an image created under the _static_ directory, or you could paste a SVG definition!
 
 {{% notice note %}}
 The size of the logo will adapt automatically.

exampleSite/content/configuration/customization/_index.en.md

@@ -250,7 +250,7 @@ document.addEventListener( 'themeVariantLoaded', function( e ){
 
 The Relearn theme has been built to be as configurable as possible by defining multiple [partials](https://gohugo.io/templates/partials/)
 
-In `themes/hugo-theme-relearn/layouts/partials/`, you will find all the partials defined for this theme. If you need to overwrite something, don't change the code directly. Instead [follow this page](https://gohugo.io/themes/customizing/). You'd create a new partial in the `layouts/partials` folder of your local project. This partial will have the priority.
+In `themes/hugo-theme-relearn/layouts/partials/`, you will find all the partials defined for this theme. If you need to overwrite something, don't change the code directly. Instead [follow this page](https://gohugo.io/themes/customizing/). You'd create a new partial in the `layouts/partials` directory of your local project. This partial will have the priority.
 
 This theme defines the following partials :
 

exampleSite/content/configuration/i18n/_index.en.md

@@ -88,7 +88,7 @@ Keep in mind that the language code required here, is the base language code. E.
 
 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/<idlanguage>.toml` and inspire yourself from the theme `themes/hugo-theme-relearn/i18n/en.toml`
+To override these values, create a new file in your local i18n directory `i18n/<idlanguage>.toml` and inspire yourself from the theme `themes/hugo-theme-relearn/i18n/en.toml`
 
 ## Disable language switching
 

exampleSite/content/content/markdown.en.md

@@ -19,7 +19,7 @@ Some of the key benefits are:
 
 John Gruber, the author of Markdown, puts it like this:
 
-> The overriding design goal for Markdown’s formatting syntax is to make it as readable as possible. The idea is that a Markdown-formatted document should be publishable as-is, as plain text, without looking like it’s been marked up with tags or formatting instructions. While Markdown’s syntax has been influenced by several existing text-to-HTML filters, the single biggest source of inspiration for Markdown’s syntax is the format of plain text email.
+> The overriding design goal for Markdown's formatting syntax is to make it as readable as possible. The idea is that a Markdown-formatted document should be publishable as-is, as plain text, without looking like it's been marked up with tags or formatting instructions. While Markdown's syntax has been influenced by several existing text-to-HTML filters, the single biggest source of inspiration for Markdown's syntax is the format of plain text email.
 > <cite>John Gruber</cite>
 
 {{% notice tip %}}

exampleSite/content/content/organization/index.en.md

@@ -5,9 +5,9 @@ weight = 1
 
 In **Hugo**, pages are the core of your site. Once it is configured, pages are definitely the added value to your documentation site.
 
-## Folders
+## Directories
 
-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_ directory with all your pages.
 
 ````plaintext
 content
@@ -36,7 +36,7 @@ content
 ````
 
 {{% notice note %}}
-`_index.md` is required in each folder, it’s your “folder home page”
+`_index.md` is required in each directory, it's your "directory's home page"
 {{% /notice %}}
 
 ## Create your project

exampleSite/content/shortcodes/attachments/index.en.md

@@ -65,9 +65,9 @@ While the examples are using shortcodes with named parameter you are free to als
 
 ### Single language
 
-The shortcode lists files found in a specific folder. The name of the folder depends on your page type (either branch bundle, leaf bundle or page).
+The shortcode lists files found in a specific directory. The name of the directory depends on your page type (either branch bundle, leaf bundle or page).
 
-1. If your page is a leaf bundle, attachments must be placed in a nested `index.files` folder, accordingly.
+1. If your page is a leaf bundle, attachments must be placed in a nested `index.files` directory, accordingly.
 
     > * content
     >   * _index.md
@@ -76,7 +76,7 @@ The shortcode lists files found in a specific folder. The name of the folder dep
     >     * **index.files**
     >       * attachment.pdf
 
-2. If your page is a branch bundle, attachments must be placed in a nested `_index.files` folder, accordingly.
+2. If your page is a branch bundle, attachments must be placed in a nested `_index.files` directory, accordingly.
 
     {{% badge style="warning" title=" " %}}Warning{{% /badge %}} This is only available for Hugo < `0.112.0`
 
@@ -87,7 +87,7 @@ The shortcode lists files found in a specific folder. The name of the folder dep
     >     * **_index.files**
     >       * attachment.pdf
 
-3. For simple pages, attachments must be placed in a folder named like your page and ending with `.files`.
+3. For simple pages, attachments must be placed in a directory named like your page and ending with `.files`.
 
     {{% badge style="warning" title=" " %}}Warning{{% /badge %}} This is only available for Hugo < `0.112.0`
 
@@ -99,7 +99,7 @@ The shortcode lists files found in a specific folder. The name of the folder dep
 
 ### Multilingual
 
-Be aware that if you use a multilingual website, you will need to have as many folders as languages and the language code must be part of the folder name.
+Be aware that if you use a multilingual website, you will need to have as many directories as languages and the language code must be part of the directory name.
 
 Eg. for a site in English and Piratish:
 

exampleSite/makeTransByConentDir.js

@@ -1,4 +1,4 @@
-// Converts a multilang content folder given in the form of "Translation by Filename"
+// Converts a multilang content directory given in the form of "Translation by Filename"
 // into the form of "Translation by content directory"
 // see https://gohugo.io/content-management/multilingual/#translate-your-content