diff --git a/README.md b/README.md index abec67680f..22476ab852 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ The Relearn theme is an enhanced fork of the popular [Learn theme](https://githu - [Chapter and site-wide printing capabilities](https://mcshelby.github.io/hugo-theme-relearn/configuration/appearance/topbar#print-support) - [Versatile search options: in-page, popup, and dedicated search page](https://mcshelby.github.io/hugo-theme-relearn/configuration/sidebar/search) - [Customizable top bar buttons](https://mcshelby.github.io/hugo-theme-relearn/configuration/customization/topbar) - - [Nested navigation menu](https://mcshelby.github.io/hugo-theme-relearn/content/structure) + - [Nested navigation menu](https://mcshelby.github.io/hugo-theme-relearn/authoring/structure) - [Configurable menu shortcuts](https://mcshelby.github.io/hugo-theme-relearn/configuration/sidebar/shortcutmenu) - [Support for hidden pages](https://mcshelby.github.io/hugo-theme-relearn/configuration/content/hidden) - [Comprehensive taxonomy support](https://mcshelby.github.io/hugo-theme-relearn/configuration/customization/taxonomy) @@ -43,8 +43,8 @@ The Relearn theme is an enhanced fork of the popular [Learn theme](https://githu - [Multilingual content search capabilities](https://mcshelby.github.io/hugo-theme-relearn/configuration/sidebar/search#mixed-language-support) - **Enhanced Markdown Features** - - [GitHub Flavored Markdown (GFM) support](https://mcshelby.github.io/hugo-theme-relearn/content/markdown) - - [Support for Obsidian callouts](https://mcshelby.github.io/hugo-theme-relearn/content/markdown#obsidian-callouts) + - [GitHub Flavored Markdown (GFM) support](https://mcshelby.github.io/hugo-theme-relearn/authoring/markdown) + - [Support for Obsidian callouts](https://mcshelby.github.io/hugo-theme-relearn/authoring/markdown#obsidian-callouts) - [Advanced image manipulation like lightbox, sizing, shadows, borders, and alignment](https://mcshelby.github.io/hugo-theme-relearn/configuration/customization/imageeffects) - **Rich Shortcode Library** diff --git a/exampleSite/content/content/_index.en.md b/exampleSite/content/authoring/_index.en.md similarity index 91% rename from exampleSite/content/content/_index.en.md rename to exampleSite/content/authoring/_index.en.md index a23918c043..548ebc8d1d 100644 --- a/exampleSite/content/content/_index.en.md +++ b/exampleSite/content/authoring/_index.en.md @@ -1,6 +1,6 @@ +++ menuPre = " " -title = "Content" +title = "Authoring" type = "chapter" weight = 3 +++ diff --git a/exampleSite/content/content/_index.pir.md b/exampleSite/content/authoring/_index.pir.md similarity index 100% rename from exampleSite/content/content/_index.pir.md rename to exampleSite/content/authoring/_index.pir.md diff --git a/exampleSite/content/content/designs/_index.en.md b/exampleSite/content/authoring/designs/_index.en.md similarity index 100% rename from exampleSite/content/content/designs/_index.en.md rename to exampleSite/content/authoring/designs/_index.en.md diff --git a/exampleSite/content/content/designs/_index.pir.md b/exampleSite/content/authoring/designs/_index.pir.md similarity index 100% rename from exampleSite/content/content/designs/_index.pir.md rename to exampleSite/content/authoring/designs/_index.pir.md diff --git a/exampleSite/content/content/designs/pages-chapter.png b/exampleSite/content/authoring/designs/pages-chapter.png similarity index 100% rename from exampleSite/content/content/designs/pages-chapter.png rename to exampleSite/content/authoring/designs/pages-chapter.png diff --git a/exampleSite/content/content/designs/pages-default.png b/exampleSite/content/authoring/designs/pages-default.png similarity index 100% rename from exampleSite/content/content/designs/pages-default.png rename to exampleSite/content/authoring/designs/pages-default.png diff --git a/exampleSite/content/content/designs/pages-home.png b/exampleSite/content/authoring/designs/pages-home.png similarity index 100% rename from exampleSite/content/content/designs/pages-home.png rename to exampleSite/content/authoring/designs/pages-home.png diff --git a/exampleSite/content/content/frontmatter/_index.en.md b/exampleSite/content/authoring/frontmatter/_index.en.md similarity index 100% rename from exampleSite/content/content/frontmatter/_index.en.md rename to exampleSite/content/authoring/frontmatter/_index.en.md diff --git a/exampleSite/content/content/frontmatter/_index.pir.md b/exampleSite/content/authoring/frontmatter/_index.pir.md similarity index 100% rename from exampleSite/content/content/frontmatter/_index.pir.md rename to exampleSite/content/authoring/frontmatter/_index.pir.md diff --git a/exampleSite/content/content/frontmatter/frontmatter.toml b/exampleSite/content/authoring/frontmatter/frontmatter.toml similarity index 100% rename from exampleSite/content/content/frontmatter/frontmatter.toml rename to exampleSite/content/authoring/frontmatter/frontmatter.toml diff --git a/exampleSite/content/content/imageeffects.en.md b/exampleSite/content/authoring/imageeffects.en.md similarity index 89% rename from exampleSite/content/content/imageeffects.en.md rename to exampleSite/content/authoring/imageeffects.en.md index 36e42e8137..cdfb8c5e9a 100644 --- a/exampleSite/content/content/imageeffects.en.md +++ b/exampleSite/content/authoring/imageeffects.en.md @@ -5,7 +5,7 @@ title = "Image Effects" weight = 7 +++ -The theme offers [graphical effects](content/markdown#image-effects) for your linked images. +The theme offers [graphical effects](authoring/markdown#image-effects) for your linked images. You can [define additional custom image effects](configuration/customization/imageeffects) in your configuration. @@ -18,7 +18,7 @@ The default image effects shipped with the theme are | lightbox | The image will be clickable to show it enlarged | | shadow | Draws a shadow around the image to make it appear hovered/glowing | -As [described](content/markdown#image-effects), one way to use them is to add them as URL query parameter. +As [described](authoring/markdown#image-effects), one way to use them is to add them as URL query parameter. This can become cumbersome to be done consistently for the whole site. Instead, you can configure the defaults in your `hugo.toml` as well as overriding these defaults in a page's front matter. diff --git a/exampleSite/content/content/imageeffects.pir.md b/exampleSite/content/authoring/imageeffects.pir.md similarity index 100% rename from exampleSite/content/content/imageeffects.pir.md rename to exampleSite/content/authoring/imageeffects.pir.md diff --git a/exampleSite/content/content/markdown.en.md b/exampleSite/content/authoring/markdown.en.md similarity index 100% rename from exampleSite/content/content/markdown.en.md rename to exampleSite/content/authoring/markdown.en.md diff --git a/exampleSite/content/content/markdown.pir.md b/exampleSite/content/authoring/markdown.pir.md similarity index 100% rename from exampleSite/content/content/markdown.pir.md rename to exampleSite/content/authoring/markdown.pir.md diff --git a/exampleSite/content/content/meta/_index.en.md b/exampleSite/content/authoring/meta/_index.en.md similarity index 100% rename from exampleSite/content/content/meta/_index.en.md rename to exampleSite/content/authoring/meta/_index.en.md diff --git a/exampleSite/content/content/meta/_index.pir.md b/exampleSite/content/authoring/meta/_index.pir.md similarity index 100% rename from exampleSite/content/content/meta/_index.pir.md rename to exampleSite/content/authoring/meta/_index.pir.md diff --git a/exampleSite/content/content/navigationmenu/_index.en.md b/exampleSite/content/authoring/navigationmenu/_index.en.md similarity index 91% rename from exampleSite/content/content/navigationmenu/_index.en.md rename to exampleSite/content/authoring/navigationmenu/_index.en.md index 0e178d1412..197ec26f0b 100644 --- a/exampleSite/content/content/navigationmenu/_index.en.md +++ b/exampleSite/content/authoring/navigationmenu/_index.en.md @@ -10,7 +10,7 @@ By default, the Relearn theme will use a page's `title` front matter for the men But a page's title has to be descriptive on its own while the menu is a hierarchy. Use `linkTitle` to shorten the text of the menu entry. -For example (for a page named `content/install/linux.md`): +For example (for a page named `install/linux.md`): {{< multiconfig fm=true >}} title = "Install on Linux" @@ -70,9 +70,9 @@ You can see this feature in action on the example page for [children shortcode]( You may want to structure your pages in a hierarchical way but don't want to generate pages for those sections? The theme got you covered. -To stay with the [initial example](content/structure): Suppose you want `introduction/first-content` appear in the sidebar but don't want to generate a page for it. So the entry in the sidebar should not be clickable but should show an expander. +To stay with the [initial example](authoring/structure): Suppose you want `first-chapter/first-page` appear in the sidebar but don't want to generate a page for it. So the entry in the sidebar should not be clickable but should show an expander. -For this, open `content/introduction/first-content/_index.md` and add the following front matter +For this, open `content/first-chapter/first-page/_index.md` and add the following front matter {{< multiconfig fm=true >}} collapsibleMenu = true diff --git a/exampleSite/content/content/navigationmenu/_index.pir.md b/exampleSite/content/authoring/navigationmenu/_index.pir.md similarity index 100% rename from exampleSite/content/content/navigationmenu/_index.pir.md rename to exampleSite/content/authoring/navigationmenu/_index.pir.md diff --git a/exampleSite/content/content/navigationmenu/frontmatter-icon.png b/exampleSite/content/authoring/navigationmenu/frontmatter-icon.png similarity index 100% rename from exampleSite/content/content/navigationmenu/frontmatter-icon.png rename to exampleSite/content/authoring/navigationmenu/frontmatter-icon.png diff --git a/exampleSite/content/content/structure/index.en.md b/exampleSite/content/authoring/structure/index.en.md similarity index 85% rename from exampleSite/content/content/structure/index.en.md rename to exampleSite/content/authoring/structure/index.en.md index a5ec689779..e3bbda38b8 100644 --- a/exampleSite/content/content/structure/index.en.md +++ b/exampleSite/content/authoring/structure/index.en.md @@ -12,18 +12,18 @@ Organize your site like [any other Hugo project](https://gohugo.io/content/struc ````plaintext content -├── introduction -│ ├── first-content +├── first-chapter +│ ├── first-page | | |── _index.md -| │ ├── sub-content +| │ ├── first-sub-page | | | |── _index.md | | | |── picture1.png | | | └── plain.txt -│ ├── second-content +│ ├── second-page | | |── index.md | | |── picture1.png | | └── picture2.png -│ └── third-content.md +│ └── third-page.md └── _index.md ```` diff --git a/exampleSite/content/content/structure/index.pir.md b/exampleSite/content/authoring/structure/index.pir.md similarity index 100% rename from exampleSite/content/content/structure/index.pir.md rename to exampleSite/content/authoring/structure/index.pir.md diff --git a/exampleSite/content/configuration/customization/designs/index.en.md b/exampleSite/content/configuration/customization/designs/index.en.md index 1bff67e1bc..8a7169e9a2 100644 --- a/exampleSite/content/configuration/customization/designs/index.en.md +++ b/exampleSite/content/configuration/customization/designs/index.en.md @@ -21,7 +21,7 @@ All shipped designs use the theme's framework from `themes/hugo-theme-learn/layo ## Using a Page Design -Regardless of shipped or custom page design, you are [using them](content/designs) in the same way. +Regardless of shipped or custom page design, you are [using them](authoring/designs) in the same way. ## Creating a Page Designs diff --git a/exampleSite/content/configuration/customization/imageeffects.en.md b/exampleSite/content/configuration/customization/imageeffects.en.md index 14547def89..0b88bc863f 100644 --- a/exampleSite/content/configuration/customization/imageeffects.en.md +++ b/exampleSite/content/configuration/customization/imageeffects.en.md @@ -5,9 +5,9 @@ title = "Image Effects" weight = 3 +++ -This page shows you, how to configure custom [image effects](content/markdown#image-effects) on top of existing ones. +This page shows you, how to configure custom [image effects](authoring/markdown#image-effects) on top of existing ones. -This setting can also be overridden by your front matter. For a detailed usage example, see [this page](content/imageeffects). +This setting can also be overridden by your front matter. For a detailed usage example, see [this page](authoring/imageeffects). If you don't configure anything in your `hugo.toml`, the image effects default to diff --git a/exampleSite/content/configuration/sidebar/navigationmenu/_index.en.md b/exampleSite/content/configuration/sidebar/navigationmenu/_index.en.md index c4db755148..3eca41b0fb 100644 --- a/exampleSite/content/configuration/sidebar/navigationmenu/_index.en.md +++ b/exampleSite/content/configuration/sidebar/navigationmenu/_index.en.md @@ -5,7 +5,7 @@ title = "Navigation Menu" weight = 4 +++ -The navigation menu is automatically created from [your content files](content/structure). +The navigation menu is automatically created from [your content files](authoring/structure). All configurations options apply to all pages but can be changed in each page's front matter. @@ -18,7 +18,7 @@ All configurations options apply to all pages but can be changed in each page's alwaysopen = true {{< /multiconfig >}} -See the [user guide](content/navigationmenu#expand-state-of-nested-sections) how this setting will be applied. +See the [user guide](authoring/navigationmenu#expand-state-of-nested-sections) how this setting will be applied. ## Expander for Nested Sections diff --git a/exampleSite/content/configuration/sitemanagement/multilingual/_index.en.md b/exampleSite/content/configuration/sitemanagement/multilingual/_index.en.md index da88b0ee7c..088577b0d5 100644 --- a/exampleSite/content/configuration/sitemanagement/multilingual/_index.en.md +++ b/exampleSite/content/configuration/sitemanagement/multilingual/_index.en.md @@ -60,15 +60,15 @@ Here's how to make your site multilingual using [translations by file name](http ````plaintext ├── content - │ ├── basics - │ │ ├── first-content + │ ├── first-chapter + │ │ ├── first-page | | | ├── _index.en.md | | | └── _index.pir.md - │ │ ├── second-content - | | | ├── _index.en.md - | | | └── _index.pir.md - │ │ ├── third-content.en.md - │ │ └── third-content.pir.md + │ │ ├── second-page + | | | ├── index.en.md + | | | └── index.pir.md + │ │ ├── third-page.en.md + │ │ └── third-page.pir.md │ ├── _index.en.md │ └── _index.pir.md ├── themes diff --git a/exampleSite/content/configuration/sitemanagement/structure/_index.en.md b/exampleSite/content/configuration/sitemanagement/structure/_index.en.md index 05b1018edc..1791d2efe5 100644 --- a/exampleSite/content/configuration/sitemanagement/structure/_index.en.md +++ b/exampleSite/content/configuration/sitemanagement/structure/_index.en.md @@ -8,12 +8,12 @@ If you've followed the [Getting Started](introduction/quickstart) guide, your di ````plaintext ├── content -│ ├── introduction -│ │ ├── first-content +│ ├── first-chapter +│ │ ├── first-page | | | └── _index.md -│ │ ├── second-content -| | | └── _index.md -│ │ └── third-content.md +│ │ ├── second-page +| | | └── index.md +│ │ └── third-page.md │ └── _index.md ├── themes │ └── hugo-theme-relearn diff --git a/exampleSite/content/introduction/quickstart/_index.en.md b/exampleSite/content/introduction/quickstart/_index.en.md index 62626b8b0a..6e32a1887d 100644 --- a/exampleSite/content/introduction/quickstart/_index.en.md +++ b/exampleSite/content/introduction/quickstart/_index.en.md @@ -84,7 +84,7 @@ Start by making a home page hugo new --kind home _index.md ```` -The new home page file `content/_index.md` has two parts: the page info (like `title`) at the top, called [front matter](https://gohugo.io/content-management/front-matter/), and the page content below. +The new home page file `authoring/_index.md` has two parts: the page info (like `title`) at the top, called [front matter](https://gohugo.io/content-management/front-matter/), and the page content below. ## Create your First Chapter Page @@ -93,19 +93,19 @@ Chapters are top-level pages that contain other pages. They have a special layou Make your first chapter page ````shell -hugo new --kind chapter introduction/_index.md +hugo new --kind chapter first-chapter/_index.md ```` -The new file `content/introduction/_index.md` has a `weight` number in the front matter. This sets the chapter's subtitle and its order in the menu. +The new file `content/first-chapter/_index.md` has a `weight` number in the front matter. This sets the chapter's subtitle and its order in the menu. ## Create your First Content Pages Now make content pages inside the chapter. Here are three ways to do this ````shell -hugo new introduction/first-content/_index.md -hugo new introduction/second-content/index.md -hugo new introduction/third-content.md +hugo new first-chapter/first-page/_index.md +hugo new first-chapter/second-page/index.md +hugo new first-chapter/third-page.md ```` Hugo treats these files differently based on their file names. Learn more in [Hugo's guide](https://gohugo.io/content-management/). @@ -144,4 +144,4 @@ Your site is now fully functional. You can continue [configuring your site](configuration) to your needs. -Or just start [writing content](content) and learn what's possible. +Or just start [authoring content](authoring) and discover what's possible. diff --git a/exampleSite/content/introduction/releasenotes/2/0.en.md b/exampleSite/content/introduction/releasenotes/2/0.en.md index c49a3a8d73..426ab51329 100644 --- a/exampleSite/content/introduction/releasenotes/2/0.en.md +++ b/exampleSite/content/introduction/releasenotes/2/0.en.md @@ -24,7 +24,7 @@ weight = -0 ### New -- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} You can define the expansion state of your menus in the front matter. Please see further [documentation](content/navigationmenu#expand-state-of-nested-sections) for possible values and default behavior. +- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} You can define the expansion state of your menus in the front matter. Please see further [documentation](authoring/navigationmenu#expand-state-of-nested-sections) for possible values and default behavior. - {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} New partials for defining pre/post content for menu items and the content. See [documentation](configuration/customization/partials) for further reading. diff --git a/exampleSite/content/introduction/releasenotes/2/4.en.md b/exampleSite/content/introduction/releasenotes/2/4.en.md index 7949a9d867..8208f9b1c0 100644 --- a/exampleSite/content/introduction/releasenotes/2/4.en.md +++ b/exampleSite/content/introduction/releasenotes/2/4.en.md @@ -16,7 +16,7 @@ weight = -4 - {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} Hidden pages are displayed by default in their according tags page. You can now turn off this behavior by setting `disableTagHiddenPages=true` in your `hugo.toml`. -- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} You can define the expansion state of your menus for the whole site by setting the `alwaysopen` option in your `hugo.toml`. Please see further [documentation](content/navigationmenu#expand-state-of-nested-sections) for possible values and default behavior. +- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} You can define the expansion state of your menus for the whole site by setting the `alwaysopen` option in your `hugo.toml`. Please see further [documentation](authoring/navigationmenu#expand-state-of-nested-sections) for possible values and default behavior. - {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} New front matter `ordersectionsby` option to change immediate children sorting in menu and `children` shortcode. Possible values are `title` or `weight`. diff --git a/exampleSite/content/introduction/releasenotes/5/0.en.md b/exampleSite/content/introduction/releasenotes/5/0.en.md index d233d83780..139b29d01c 100644 --- a/exampleSite/content/introduction/releasenotes/5/0.en.md +++ b/exampleSite/content/introduction/releasenotes/5/0.en.md @@ -18,7 +18,7 @@ weight = -0 ### Change -- {{% badge style="note" title=" " %}}Change{{% /badge %}} The way [archetypes](content/designs) are used to generate output has changed. The new systems allows you, to redefine existing archetypes or even generate your own ones. +- {{% badge style="note" title=" " %}}Change{{% /badge %}} The way [archetypes](authoring/designs) are used to generate output has changed. The new systems allows you, to redefine existing archetypes or even generate your own ones. Your existing markdown files will still work like before and therefore you don't need to change anything after the upgrade. Nevertheless, it is recommended to adapt your existing markdown files to the new way as follows: diff --git a/exampleSite/content/introduction/releasenotes/5/11.en.md b/exampleSite/content/introduction/releasenotes/5/11.en.md index 156e6991a6..f9cb0fbbe5 100644 --- a/exampleSite/content/introduction/releasenotes/5/11.en.md +++ b/exampleSite/content/introduction/releasenotes/5/11.en.md @@ -32,7 +32,7 @@ weight = -11 - {{% badge style="note" title=" " %}}Change{{% /badge %}} The JavaScript code for handling image lightboxes (provided by [Featherlight](https://noelboss.github.io/featherlight)) was replaced by a CSS-only solution. - This also changed the [lightbox effects](content/markdown#lightbox) parameter from `featherlight=false` to `lightbox=false`. Nevertheless you don't need to change anything as the old name will be used as a fallback. + This also changed the [lightbox effects](authoring/markdown#lightbox) parameter from `featherlight=false` to `lightbox=false`. Nevertheless you don't need to change anything as the old name will be used as a fallback. - {{% badge style="note" title=" " %}}Change{{% /badge %}} In the effort to comply with WCAG standards, the implementation of the [`expand` shortcode](shortcodes/expand) was changed. While Internet Explorer 11 has issues in displaying it, the functionality still works. diff --git a/exampleSite/content/introduction/releasenotes/5/20.en.md b/exampleSite/content/introduction/releasenotes/5/20.en.md index 6089816b45..c386cebb92 100644 --- a/exampleSite/content/introduction/releasenotes/5/20.en.md +++ b/exampleSite/content/introduction/releasenotes/5/20.en.md @@ -33,7 +33,7 @@ weight = -20 For existing variants nothing has changed visually. -- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The default values for the [image effects](content/markdown#image-effects) are [now configurable](configuration/customization/imageeffects) for your whole site via `hugo.toml` or for each page through front matter. +- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The default values for the [image effects](authoring/markdown#image-effects) are [now configurable](configuration/customization/imageeffects) for your whole site via `hugo.toml` or for each page through front matter. - {{% 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`. diff --git a/exampleSite/content/introduction/releasenotes/5/22.en.md b/exampleSite/content/introduction/releasenotes/5/22.en.md index 7826927c67..72ec196794 100644 --- a/exampleSite/content/introduction/releasenotes/5/22.en.md +++ b/exampleSite/content/introduction/releasenotes/5/22.en.md @@ -16,7 +16,7 @@ weight = -22 - {{% badge style="note" title=" " %}}Change{{% /badge %}} You can now have structural sections in the hierarchical menu without generating a page for it. - This can come in handy, if content for such a section page doesn't make much sense to you. See [the documentation](content/navigationmenu#disable-section-pages) for how to do this. + This can come in handy, if content for such a section page doesn't make much sense to you. See [the documentation](authoring/navigationmenu#disable-section-pages) for how to do this. This feature may require you to make changes to your existing installation if you are already using _[shortcuts to pages inside of your project](configuration/sidebar/shortcutmenu#displaying-pages-only-in-the-shortcuts-menu)_ with a _headless branch parent_. diff --git a/exampleSite/content/introduction/releasenotes/5/23.en.md b/exampleSite/content/introduction/releasenotes/5/23.en.md index 8cf20216be..70dbcc1913 100644 --- a/exampleSite/content/introduction/releasenotes/5/23.en.md +++ b/exampleSite/content/introduction/releasenotes/5/23.en.md @@ -36,7 +36,7 @@ weight = -23 - {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} It is now possible to adjust the menu width for your whole site. [See the docs](configuration/sidebar/width). -- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} This release adds social media meta tags for the Open Graph protocol and Twitter Cards to your site. [See the docs](content/meta). +- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} This release adds social media meta tags for the Open Graph protocol and Twitter Cards to your site. [See the docs](authoring/meta). - {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} This release comes with additional sort options for the menu and the [`children` shortcode](shortcodes/children). Both will now accept the following values: `weight`, `title`, `linktitle`, `modifieddate`, `expirydate`, `publishdate`, `date`, `length` or `default` (adhering to Hugo's default sort order). diff --git a/exampleSite/content/introduction/releasenotes/5/24.en.md b/exampleSite/content/introduction/releasenotes/5/24.en.md index 5ccb89b898..a2d1e26df8 100644 --- a/exampleSite/content/introduction/releasenotes/5/24.en.md +++ b/exampleSite/content/introduction/releasenotes/5/24.en.md @@ -42,9 +42,9 @@ weight = -24 - {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} Improvements for accessibility when tabbing through the page for images, links and tab handles. -- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The `editURL` config parameter is now [overwritable in your pages front matter](content/frontmatter). In addition it received more versatility by letting you control where to put the file path into the URL. This is achieved by replacing the variable `${FilePath}` in your URL by the pages file path. You don't need to change anything in your existing configuration as the old way without the replacement variable still works. +- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The `editURL` config parameter is now [overwritable in your pages front matter](authoring/frontmatter). In addition it received more versatility by letting you control where to put the file path into the URL. This is achieved by replacing the variable `${FilePath}` in your URL by the pages file path. You don't need to change anything in your existing configuration as the old way without the replacement variable still works. -- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The themes [config](configuration/options) and [front matter](content/frontmatter) options received a comprehensive documentation update. In addition the theme switched from `config.toml` to `hugo.toml`. +- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The themes [config](configuration/options) and [front matter](authoring/frontmatter) options received a comprehensive documentation update. In addition the theme switched from `config.toml` to `hugo.toml`. - {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} Restored compatibility with Hugo versions {{% badge color="fuchsia" icon="fa-fw fab fa-hackerrank" title=" " %}}0.121.0{{% /badge %}} or higher for the [`highlight` shortcode](shortcodes/highlight). This does not change the minimum required Hugo version. diff --git a/exampleSite/content/introduction/releasenotes/5/27.en.md b/exampleSite/content/introduction/releasenotes/5/27.en.md index f06e7626c2..bee1604370 100644 --- a/exampleSite/content/introduction/releasenotes/5/27.en.md +++ b/exampleSite/content/introduction/releasenotes/5/27.en.md @@ -26,7 +26,7 @@ weight = -27 ### New -- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} Additional styling was added for the native HTML elements `` and ``. To use them you must allow the [usage of HTML](https://gohugo.io/getting-started/configuration-markup/#rendererunsafe) in your `hugo.toml`. The [Markdown documentation](content/markdown#standard-and-extensions) was enhanced for this. +- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} Additional styling was added for the native HTML elements `` and ``. To use them you must allow the [usage of HTML](https://gohugo.io/getting-started/configuration-markup/#rendererunsafe) in your `hugo.toml`. The [Markdown documentation](authoring/markdown#standard-and-extensions) was enhanced for this. - {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} You now can scroll forward and backward through all headings of a page by using ALT 🡑 and ALT 🡓. This also works for the `PRINT` output format. diff --git a/exampleSite/content/introduction/releasenotes/5/3.en.md b/exampleSite/content/introduction/releasenotes/5/3.en.md index 54e65f7c76..f35ba29ed5 100644 --- a/exampleSite/content/introduction/releasenotes/5/3.en.md +++ b/exampleSite/content/introduction/releasenotes/5/3.en.md @@ -14,6 +14,6 @@ weight = -3 ### New -- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} [Image formatting](content/markdown#css-classes) has two new classes to align images to the `left` or `right`. Additionally, the already existing `inline` option is now documented. +- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} [Image formatting](authoring/markdown#css-classes) has two new classes to align images to the `left` or `right`. Additionally, the already existing `inline` option is now documented. - {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} Printing for the [`swagger` shortcode](shortcodes/openapi) was optimized to expand sections that are usually closed in interactive mode. This requires [print support](configuration/appearance/topbar#print-support) to be configured. diff --git a/exampleSite/content/introduction/releasenotes/5/5.en.md b/exampleSite/content/introduction/releasenotes/5/5.en.md index 03341514a9..5f18dfe57b 100644 --- a/exampleSite/content/introduction/releasenotes/5/5.en.md +++ b/exampleSite/content/introduction/releasenotes/5/5.en.md @@ -12,7 +12,7 @@ weight = -5 - {{% badge style="note" title=" " %}}Change{{% /badge %}} The way images are processed has changed. Now images are lazy loaded by default which speeds up page load on slow networks and/or big pages and also the print preview. - For that the JavaScript code to handle the [lightbox and image effects](content/markdown#image-effects) on the client side was removed in favour for static generation of those effects on the server. + For that the JavaScript code to handle the [lightbox and image effects](authoring/markdown#image-effects) on the client side was removed in favour for static generation of those effects on the server. If you have used HTML directly in your Markdown files, this now has the downside that it doesn't respect the effect query parameter anymore. In this case you have to migrate all your HTML `img` URLs manually to the respective HTML attributes. diff --git a/exampleSite/content/introduction/releasenotes/5/8.en.md b/exampleSite/content/introduction/releasenotes/5/8.en.md index 10f0d7ef0c..34125cfe6b 100644 --- a/exampleSite/content/introduction/releasenotes/5/8.en.md +++ b/exampleSite/content/introduction/releasenotes/5/8.en.md @@ -14,6 +14,6 @@ weight = -8 - {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The new [`icon` shortcode](shortcodes/icon) simplyfies the usage of icons. This can even be combined with also new `badge` shortcode. -- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The theme now supports some of GFM (GitHub Flavored Markdown) syntax and Hugo Markdown extensions, namely [task lists](content/markdown#tasks), [defintion lists](content/markdown#definitions) and [footnotes](content/markdown#footnotes). +- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The theme now supports some of GFM (GitHub Flavored Markdown) syntax and Hugo Markdown extensions, namely [task lists](authoring/markdown#tasks), [defintion lists](authoring/markdown#definitions) and [footnotes](authoring/markdown#footnotes). - {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} A new color `--ACCENT-color` was introduced which is used for highlighting search results on the page. In case you simply don't care, you don't need to change anything in your variant stylesheet as the old `yellow` color is still used as default. diff --git a/exampleSite/content/introduction/releasenotes/6/1.en.md b/exampleSite/content/introduction/releasenotes/6/1.en.md index 5592fa5561..ac23e881d1 100644 --- a/exampleSite/content/introduction/releasenotes/6/1.en.md +++ b/exampleSite/content/introduction/releasenotes/6/1.en.md @@ -18,7 +18,7 @@ weight = -1 - {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The [`openapi` shortcode](shortcodes/openapi) is now able to resolve links to resources as well as to files in the file system (the old behavior). You can configure to generate warnings or errors during build by setting `openapi.errorlevel` to either `warning` or `error` in your `hugo.toml` if a path can not be resolved. -- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} Shortcodes supporting an `errorlevel` configuration can now have overridden values in the [front matter](content/frontmatter) section of each individual page. +- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} Shortcodes supporting an `errorlevel` configuration can now have overridden values in the [front matter](authoring/frontmatter) section of each individual page. - {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The theme now comes with its own overridden version of the `relref` shortcode. diff --git a/exampleSite/content/introduction/releasenotes/6/2.en.md b/exampleSite/content/introduction/releasenotes/6/2.en.md index 1be7b0fe4e..f1076f301d 100644 --- a/exampleSite/content/introduction/releasenotes/6/2.en.md +++ b/exampleSite/content/introduction/releasenotes/6/2.en.md @@ -18,7 +18,7 @@ weight = -2 ### New -- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} If you are running Hugo {{% badge color="fuchsia" icon="fa-fw fab fa-hackerrank" title=" " %}}0.132.0{{% /badge %}} or later, the theme is now capable to print [GitHub styled alerts](content/markdown#github-styled-alerts). +- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} If you are running Hugo {{% badge color="fuchsia" icon="fa-fw fab fa-hackerrank" title=" " %}}0.132.0{{% /badge %}} or later, the theme is now capable to print [GitHub styled alerts](authoring/markdown#github-styled-alerts). - {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} To support new severity levels for GitHub styled alerts, all shortcodes that support severity levels with their `style` parameter were expanded with the new severities `caution` and `important` and the `color` parameter was expanded with `cyan` and `magenta`. Please note, that coloring and icons of severities may defer from the [display you see on GitHub](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts). diff --git a/exampleSite/content/introduction/releasenotes/6/3.en.md b/exampleSite/content/introduction/releasenotes/6/3.en.md index 7119659204..8097552e32 100644 --- a/exampleSite/content/introduction/releasenotes/6/3.en.md +++ b/exampleSite/content/introduction/releasenotes/6/3.en.md @@ -18,6 +18,6 @@ weight = -3 - {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The [`notice` shortcode](shortcodes/notice) has a new parameter `expanded` to make the content collapsible. -- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} If you are running Hugo {{% badge color="fuchsia" icon="fa-fw fab fa-hackerrank" title=" " %}}0.134.0{{% /badge %}} or later, the theme now supports [Obsidian callouts](content/markdown#obsidian-callouts). +- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} If you are running Hugo {{% badge color="fuchsia" icon="fa-fw fab fa-hackerrank" title=" " %}}0.134.0{{% /badge %}} or later, the theme now supports [Obsidian callouts](authoring/markdown#obsidian-callouts). - {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The theme has updated its Mermaid dependency to 11.1.0. This adds support for [packet](shortcodes/mermaid#packet) and [architecture](shortcodes/mermaid#architecture) diagrams. diff --git a/exampleSite/content/introduction/releasenotes/7/0.en.md b/exampleSite/content/introduction/releasenotes/7/0.en.md index c423b7bbea..eaf927c6cc 100644 --- a/exampleSite/content/introduction/releasenotes/7/0.en.md +++ b/exampleSite/content/introduction/releasenotes/7/0.en.md @@ -53,7 +53,7 @@ weight = -0 Care was taken to configure the font to look similar to the previously used Work Sans. Nevertheless, in direct comparison, you will see slight differences in appearance. - This change was necessary as the previously used font had display issues with [marked text](content/markdown#marked-text), contrast, and some other minor stuff. As an aftermath, the number of requests and the download size were decreased when loading a page. + This change was necessary as the previously used font had display issues with [marked text](authoring/markdown#marked-text), contrast, and some other minor stuff. As an aftermath, the number of requests and the download size were decreased when loading a page. Although the font was created by Google, it is licensed under OFL 1.1 and is delivered from your theme's installation. As always, no third-party server calls are involved. @@ -81,9 +81,9 @@ weight = -0 Basically, the structure was reorganized, giving each topic its own page while keeping the amount of items for each menu level comprehensible by adding sub-pages. - The docs now clearly differentiate between [configuration of your site](configuration), all things [writing page content](content) and the [shortcodes docs](shortcodes) that cover both topics, configuration and usage. + The docs now clearly differentiate between [configuration of your site](configuration), all things [writing page content](authoring) and the [shortcodes docs](shortcodes) that cover both topics, configuration and usage. - To give you a better overview of what's possible with the theme, we introduced reference pages for all theme [configuration options](configuration/options) and [front matter](content/frontmatter) and mark each occurrence of such on all pages with the badges {{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} and {{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}}. + To give you a better overview of what's possible with the theme, we introduced reference pages for all theme [configuration options](configuration/options) and [front matter](authoring/frontmatter) and mark each occurrence of such on all pages with the badges {{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} and {{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}}. Also, a lot of previously undocumented features are now included, namely diff --git a/exampleSite/content/shortcodes/icon.en.md b/exampleSite/content/shortcodes/icon.en.md index 9fc86c790e..c7efc83962 100644 --- a/exampleSite/content/shortcodes/icon.en.md +++ b/exampleSite/content/shortcodes/icon.en.md @@ -1,5 +1,4 @@ +++ -aliases = "/content/icons" description = "Nice icons for your page" title = "Icon" +++ diff --git a/exampleSite/content/shortcodes/icon.pir.md b/exampleSite/content/shortcodes/icon.pir.md index 0985460a58..5738f256b7 100644 --- a/exampleSite/content/shortcodes/icon.pir.md +++ b/exampleSite/content/shortcodes/icon.pir.md @@ -1,5 +1,4 @@ +++ -aliases = "/pir/content/icons" description = "Nice ay'cons fer yer plank" title = "Icon" +++ diff --git a/exampleSite/content/shortcodes/math.en.md b/exampleSite/content/shortcodes/math.en.md index fb464bfac0..655b2ece6d 100644 --- a/exampleSite/content/shortcodes/math.en.md +++ b/exampleSite/content/shortcodes/math.en.md @@ -5,7 +5,7 @@ options = ["customMathJaxURL", "math", "math.force", "mathJaxInitialize"] title = "Math" +++ -You can use [pure Markdown](content/markdown#subscript-and-superscript) for writing simple math expressions. +You can use [pure Markdown](authoring/markdown#subscript-and-superscript) for writing simple math expressions. If this is not enough, the `math` shortcode helps you rendering math and chemical formulae using the [MathJax](https://mathjax.org/) library. diff --git a/layouts/partials/version.txt b/layouts/partials/version.txt index 74b3c6ea82..872214daf4 100644 --- a/layouts/partials/version.txt +++ b/layouts/partials/version.txt @@ -1 +1 @@ -6.4.0+27b3d7f0eab32ab9728005e901c2574ed08c87ea \ No newline at end of file +6.4.0+8907aa613bb6130bcdc8323312b8fe8dbbeed9ce \ No newline at end of file