nishiki/hugo-theme-relearn
1
0
Fork 0
mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2025-01-18 10:50:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: harmonize internal links #567

Browse source
This commit is contained in:
Sören Weber 2024-10-07 08:31:28 +02:00
parent 1e8d064d64
commit 9a255abef9
No known key found for this signature in database
GPG key ID: BEC6D55545451B6D
31 changed files with 48 additions and 48 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
exampleSite/content/configuration/modifications/topbar/_index.en.md
View file

@ -34,7 +34,7 @@ The theme ships with the following predefined buttons (from left to right in the
- {{% button style="transparent" icon="bars" %}}{{% /button %}} [**sidebar**](https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/sidebar.html): opens the sidebar flyout if in mobile layout
- {{% button style="transparent" icon="list-alt" %}}{{% /button %}} [**toc**](https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/toc.html): opens the table of contents in an overlay
- {{% button style="transparent" icon="pen" %}}{{% /button %}} [**edit**](https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/edit.html): browses to the editable page if the `editURL` [parameter is set](configuration/options)
- {{% button style="transparent" icon="print" %}}{{% /button %}} [**print**](https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/print.html): browses to the chapters printable page if [print support](configuration/appearance/topbar/#print-support) was activated
- {{% button style="transparent" icon="print" %}}{{% /button %}} [**print**](https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/print.html): browses to the chapters printable page if [print support](configuration/appearance/topbar#print-support) was activated
- {{% button style="transparent" icon="chevron-left" %}}{{% /button %}} [**prev**](https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/prev.html): browses to the previous page if there is one
- {{% button style="transparent" icon="chevron-right" %}}{{% /button %}} [**next**](https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/next.html): browses to the next page if there is one
- {{% button style="transparent" icon="ellipsis-v" %}}{{% /button %}} [**more**](https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/more.html): opens the overlay for the _more_ area

2
exampleSite/content/configuration/siteorganization/multilingual/_index.en.md
View file

@ -79,7 +79,7 @@ Then, for each new page, append the _id_ of the language to the file.
## Configure Search
You may want to take a look into [search configuration](configuration/sidebar/search/). It has some additional options for multilingual websites.
You may want to take a look into [search configuration](configuration/sidebar/search). It has some additional options for multilingual websites.
## Disable Language Switching

4
exampleSite/content/configuration/siteorganization/structure/_index.en.md
View file

@ -6,7 +6,7 @@ weight = 1
## Structure
If you've followed the [Getting Started](introduction/quickstart/) guide, you are resulting in a directory layout similar to this
If you've followed the [Getting Started](introduction/quickstart) guide, you are resulting in a directory layout similar to this
````plaintext
├── content
@ -39,4 +39,4 @@ This makes it easy to customize the theme without having to edit files inside of
> [!WARNING]
> If you have cloned the theme repository and start editing files for your site in this clone, you're doing it wrong.
>
> Follow the [Getting Started](introduction/quickstart/) guide.
> Follow the [Getting Started](introduction/quickstart) guide.

4
exampleSite/content/introduction/quickstart/_index.en.md
View file

@ -142,6 +142,6 @@ You can upload this directory to any web server, or use one of [Hugo's many othe
Your site is now fully functional.
You can continue [configuring your site](configuration/) to your needs.
You can continue [configuring your site](configuration) to your needs.
Or just start [writing content](content/) and learn what's possible.
Or just start [writing content](content) and learn what's possible.

2
exampleSite/content/introduction/releasenotes/2/0.en.md
View file

@ -26,7 +26,7 @@ weight = -0
- {{% 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/frontmatter#override-expand-state-rules-for-menu-entries) 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/modifications/partials/) for further reading.
- {{% 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/modifications/partials) for further reading.
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} Shortcode [`children`](shortcodes/children) with new parameter `containerstyle`.

2
exampleSite/content/introduction/releasenotes/2/6.en.md
View file

@ -10,4 +10,4 @@ weight = -6
### New
- {{% 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/siteorganization/deploymentscenarios/) 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/siteorganization/deploymentscenarios) for a detailed example.

2
exampleSite/content/introduction/releasenotes/3/0.en.md
View file

@ -10,7 +10,7 @@ weight = -0
### Breaking
- {{% badge style="warning" title=" " %}}Breaking{{% /badge %}} We made changes to the menu footer. If you have your `menu-footer.html` [partial overridden](configuration/modifications/partials/), 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.
- {{% badge style="warning" title=" " %}}Breaking{{% /badge %}} We made changes to the menu footer. If you have your `menu-footer.html` [partial overridden](configuration/modifications/partials), 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).

2
exampleSite/content/introduction/releasenotes/3/4.en.md
View file

@ -16,6 +16,6 @@ weight = -4
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} If you prefer expandable/collapsible menu items, you can now set `collapsibleMenu=true` in your `hugo.toml`. This will add arrows to all menu items that contain sub menus. The menu will expand/collapse without navigation if you click on an arrow.
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} You can activate [print support](configuration/appearance/topbar/#print-support) in your `hugo.toml` to add the capability to print whole chapters or even the complete site.
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} You can activate [print support](configuration/appearance/topbar#print-support) in your `hugo.toml` to add the capability to print whole chapters or even the complete site.
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} Translation into Traditional Chinese.

2
exampleSite/content/introduction/releasenotes/4/1.en.md
View file

@ -10,4 +10,4 @@ weight = -1
### New
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} While fixing issues with the search functionality for non Latin languages, you can now [configure to have multiple languages on a single page](configuration/sidebar/search/#search-with-mixed-language-support).
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} While fixing issues with the search functionality for non Latin languages, you can now [configure to have multiple languages on a single page](configuration/sidebar/search#search-with-mixed-language-support).

2
exampleSite/content/introduction/releasenotes/5/19.en.md
View file

@ -14,7 +14,7 @@ weight = -19
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The theme has added two new color variants `zen-light` and `zen-dark`. Check it out!
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The theme now [dispatches the custom event](configuration/appearance/branding/#react-to-variant-switches-in-javascript) `themeVariantLoaded` on the `document` when the variant is fully loaded either initially or by switching the variant manually with the variant selector.
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The theme now [dispatches the custom event](configuration/appearance/branding#react-to-variant-switches-in-javascript) `themeVariantLoaded` on the `document` when the variant is fully loaded either initially or by switching the variant manually with the variant selector.
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The theme has updated its Mermaid dependency to 10.3.1. This adds support for the [sankey diagram type](shortcodes/mermaid#sankey) and now comes with full support for YAML inside Mermaid graphs (previously, the theme ignored explicit Mermaid theme settings in YAML).

4
exampleSite/content/introduction/releasenotes/5/21.en.md
View file

@ -10,10 +10,10 @@ weight = -21
### Change
- {{% badge style="note" title=" " %}}Change{{% /badge %}} We made changes to the menu footer to improve alignment with the menu items in most cases. Care was taken not to break your existing overwritten footer. Anyways, if you have your `menu-footer.html` [partial overridden](configuration/modifications/partials/), you may want to review the styling (eg. margins/paddings) of your partial.
- {{% badge style="note" title=" " %}}Change{{% /badge %}} We made changes to the menu footer to improve alignment with the menu items in most cases. Care was taken not to break your existing overwritten footer. Anyways, if you have your `menu-footer.html` [partial overridden](configuration/modifications/partials), you may want to review the styling (eg. margins/paddings) of your partial.
### New
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} This release comes with an awesome new feature, that allows you to customize your topbar buttons, change behavior, reorder them or define entirely new ones, unique to your installation. See [the documentation](configuration/modifications/topbar/) for further details.
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} This release comes with an awesome new feature, that allows you to customize your topbar buttons, change behavior, reorder them or define entirely new ones, unique to your installation. See [the documentation](configuration/modifications/topbar) for further details.
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The theme has updated its Swagger dependency to 5.7.2 for the [`openapi` shortcode](shortcodes/openapi). This brings support for OpenAPI Specification 3.1.

2
exampleSite/content/introduction/releasenotes/5/22.en.md
View file

@ -18,7 +18,7 @@ weight = -22
This can come in handy, if content for such a section page doesn't make much sense to you. See [the documentation](content/frontmatter#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/#how-to-display-pages-only-in-the-shortcuts-menu)_ with a _headless branch parent_.
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#how-to-display-pages-only-in-the-shortcuts-menu)_ with a _headless branch parent_.
In this case it is advised to remove the `title` from the headless branch parent's front matter, as it will otherwise appear in your breadcrumbs.

6
exampleSite/content/introduction/releasenotes/5/23.en.md
View file

@ -34,13 +34,13 @@ weight = -23
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} It is now possible to print custom taxonomies anywhere in your page. [See the docs](configuration/modifications/taxonomy#customization).
- {{% 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 %}} 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/image/).
- {{% 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/image).
- {{% 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).
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The theme now provides a mechanism to load further JavaScript dependencies defined by you only if it is needed. This comes in handy if you want to add own shortcodes that depend on additional JavaScript code to be loaded. [See the docs](configuration/modifications/dependencies/).
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The theme now provides a mechanism to load further JavaScript dependencies defined by you only if it is needed. This comes in handy if you want to add own shortcodes that depend on additional JavaScript code to be loaded. [See the docs](configuration/modifications/dependencies).
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The theme has updated its Mermaid dependency to 10.6.0. This adds support for the [xychart type](shortcodes/mermaid#xychart).

4
exampleSite/content/introduction/releasenotes/5/24.en.md
View file

@ -32,13 +32,13 @@ weight = -24
The advanced functionality allows you to set an explicit name for a theme variant and now allows for multiple auto mode variants that adjust to the light/dark preference of your OS settings.
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} New partial for defining the heading. See [documentation](configuration/modifications/partials/) for further reading.
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} New partial for defining the heading. See [documentation](configuration/modifications/partials) for further reading.
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} Support for Hugo's built-in [`figure` shortcode](https://gohugo.io/content-management/shortcodes/#figure).
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} On taxonomy and term pages you can now use prev/next navigation as within the normal page structure.
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} In additiion to the existing [menu width customization](configuration/sidebar/width/), it is now also possible to set the width of the menu flyout for small screen sizes with the `--MENU-WIDTH-S` CSS property.
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} In additiion to the existing [menu width customization](configuration/sidebar/width), it is now also possible to set the width of the menu flyout for small screen sizes with the `--MENU-WIDTH-S` CSS property.
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} Improvements for accessibility when tabbing through the page for images, links and tab handles.

2
exampleSite/content/introduction/releasenotes/5/26.en.md
View file

@ -12,7 +12,7 @@ weight = -26
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The lazy loading of images is now configurable by using the new `lazy` [image effect](configuration/modifications/imageeffects). The default value hasn't changed in comparison to older versions, you don't need to change anything.
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} It is now possible to [adjust the max width of the main area](configuration/content/width/), eg. in case you want to use the full page width for your content.
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} It is now possible to [adjust the max width of the main area](configuration/content/width), eg. in case you want to use the full page width for your content.
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} Images and Markdown codefences are now respecting [Hugo's Markdown attributes](https://gohugo.io/content-management/markdown-attributes/).

4
exampleSite/content/introduction/releasenotes/5/27.en.md
View file

@ -16,7 +16,7 @@ weight = -27
- {{% badge style="note" title=" " %}}Change{{% /badge %}} If the theme is configured to generate warnings or errors during build by setting `image.errorlevel` to either `warning` or `error` in your `hugo.toml`, it will now also generate output if a link fragment is not found in the target page.
- {{% badge style="note" title=" " %}}Change{{% /badge %}} The [dependency loader](configuration/modifications/dependencies/) was made more versatile.
- {{% badge style="note" title=" " %}}Change{{% /badge %}} The [dependency loader](configuration/modifications/dependencies) was made more versatile.
The configuration in your `hugo.toml` does not require the `location` parameter anymore. If you still use it, the theme will work as before but will generate a warning. So you don't need to change anything, yet.
@ -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 `<mark>` and `<kbd>`. 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 `<mark>` and `<kbd>`. 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 %}} You now can scroll forward and backward through all headings of a page by using <kbd>ALT</kbd> <kbd>🡑</kbd> and <kbd>ALT</kbd> <kbd>🡓</kbd>. This also works for the `PRINT` output format.

2
exampleSite/content/introduction/releasenotes/5/3.en.md
View file

@ -16,4 +16,4 @@ weight = -3
- {{% 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 %}} 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.
- {{% 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.

2
exampleSite/content/introduction/releasenotes/5/4.en.md
View file

@ -10,7 +10,7 @@ weight = -4
### Change
- {{% badge style="note" title=" " %}}Change{{% /badge %}} [With the proper settings](configuration/siteorganization/deploymentscenarios/) in your `hugo.toml` your page is now servable from the local file system using `file://` URLs.
- {{% badge style="note" title=" " %}}Change{{% /badge %}} [With the proper settings](configuration/siteorganization/deploymentscenarios) in your `hugo.toml` your page is now servable from the local file system using `file://` URLs.
Please note that the searchbox will only work for this if you reconfigure your outputformat for the homepage in your `hugo.toml` from `json` to `search`. The now deprecated `json` outputformat still works as before, so there is no need to reconfigure your installation if it is only served from `http://` or `https://`.

2
exampleSite/content/introduction/releasenotes/5/6.en.md
View file

@ -12,7 +12,7 @@ weight = -6
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} This release introduces an additional dedicated search page. On this page, displayed search results have more space making it easier scanning through large number of results.
To activate this feature, you need to [configure it](configuration/sidebar/search/) in your `hugo.toml` as a new outputformat `searchpage` for the home page. If you don't configure it, no dedicated search page will be accessible and the theme works as before.
To activate this feature, you need to [configure it](configuration/sidebar/search) in your `hugo.toml` as a new outputformat `searchpage` for the home page. If you don't configure it, no dedicated search page will be accessible and the theme works as before.
You can access the search page by either clicking on the magnifier glass or pressing enter inside of the search box.

2
exampleSite/content/introduction/releasenotes/5/9.en.md
View file

@ -14,7 +14,7 @@ weight = -9
It was later discovered, that this causes pages only meant to be displayed in the `More` section of the menu and stored directly inside your `content` directory to now show up in the menu as well.
To [get rid](configuration/sidebar/shortcutmenu/#how-to-display-pages-only-in-the-shortcuts-menu) of this undesired behavior you have two choices:
To [get rid](configuration/sidebar/shortcutmenu#how-to-display-pages-only-in-the-shortcuts-menu) of this undesired behavior you have two choices:
1. Make the page file a [headless branch bundle](https://gohugo.io/content-management/page-bundles/#headless-bundle) (contained in its own subdirectory and called `_index.md`) and add the following front matter configuration to the file (see exampleSite's `content/showcase/_index.en.md`). This causes its content to **not** be ontained in the sitemap.

8
exampleSite/content/introduction/releasenotes/6/0.en.md
View file

@ -28,15 +28,15 @@ weight = -0
For migration, move the `description` parameter of your `hugo.toml` into the front matter section of your home page.
- {{% badge style="warning" title=" " %}}Breaking{{% /badge %}} Search support for the `json` outputformat [deprecated in 5.4.0](introduction/releasenotes/5/#5-4-0) was removed.
- {{% badge style="warning" title=" " %}}Breaking{{% /badge %}} Search support for the `json` outputformat [deprecated in 5.4.0](introduction/releasenotes/5#5-4-0) was removed.
Change it to `search` for the homepage in your `hugo.toml`. See the docs for [detailed configuration](configuration/sidebar/search/).
Change it to `search` for the homepage in your `hugo.toml`. See the docs for [detailed configuration](configuration/sidebar/search).
- {{% badge style="warning" title=" " %}}Breaking{{% /badge %}} The front matter option `menuTitle` [deprecated in 5.24.0](introduction/releasenotes/5/#5-24-0) was removed in favor for Hugo's own `linkTitle`.
- {{% badge style="warning" title=" " %}}Breaking{{% /badge %}} The front matter option `menuTitle` [deprecated in 5.24.0](introduction/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.
- {{% badge style="warning" title=" " %}}Breaking{{% /badge %}} The `swagger` shortcode [deprecated in 5.13.0](introduction/releasenotes/5/#5-13-0) was removed in favor for the [`openapi` shortcode](shortcodes/openapi) with the same set of parameter.
- {{% badge style="warning" title=" " %}}Breaking{{% /badge %}} The `swagger` shortcode [deprecated in 5.13.0](introduction/releasenotes/5#5-13-0) was removed in favor for the [`openapi` shortcode](shortcodes/openapi) with the same set of parameter.
- {{% badge style="warning" title=" " %}}Breaking{{% /badge %}} Support for Internet Explorer 11 was finally dropped.

2
exampleSite/content/introduction/releasenotes/6/1.en.md
View file

@ -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](content/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.

2
exampleSite/content/introduction/releasenotes/6/2.en.md
View file

@ -14,7 +14,7 @@ weight = -2
If you now click on it, not only is the link copied to the clipboard (previous behavior) but also the heading scrolls to the top of the page.
If you dislike the new behavior, you can deactivate it by setting `disableAnchorScrolling=true` in your `hugo.toml`. See the [docs for further options](configuration/content/headings/).
If you dislike the new behavior, you can deactivate it by setting `disableAnchorScrolling=true` in your `hugo.toml`. See the [docs for further options](configuration/content/headings).
### New

2
exampleSite/content/introduction/releasenotes/6/4.en.md
View file

@ -14,6 +14,6 @@ weight = -4
### New
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} It is now possible to have user-defined styles for all shortcodes that accept the `style` parameter. See the [`notice` shortcode](shortcodes/notice/#defining-own-styles) for configuration.
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} It is now possible to have user-defined styles for all shortcodes that accept the `style` parameter. See the [`notice` shortcode](shortcodes/notice#defining-own-styles) for configuration.
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The [`resources` shortcode](shortcodes/resources) has a new parameter `expanded` to make the resource list collapsible.

14
exampleSite/content/introduction/releasenotes/7/0.en.md
View file

@ -47,7 +47,7 @@ weight = -0
In addition you are now able to overwrite the default file name of the search index and the default page name of the dedicated search page by changing `searchIndexURL` and `searchPageURL` respectively in your `hugo.toml`.
See the [updated documentation](configuration/sidebar/search/) for reference.
See the [updated documentation](configuration/sidebar/search) for reference.
## Change
@ -55,7 +55,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](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.
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 involved.
@ -77,13 +77,13 @@ 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](content) and the [shortcodes docs](shortcodes) that cover both topics, configuration and usage.
To give you a better overview what's possible with the theme, we introduced reference pages for all theme [configurations options](configuration/options) and [front matter](content/frontmatter) and mark each occurrence of such on all pages with 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
- the [hidden pages](configuration/content/hidden/) feature
- options of the [navigation menu](configuration/sidebar/navigationmenu/)
- configuring the [headings](configuration/content/headings/) of your content
- adding [custom output formats](configuration/modifications/outputformats/)
- the [hidden pages](configuration/content/hidden) feature
- options of the [navigation menu](configuration/sidebar/navigationmenu)
- configuring the [headings](configuration/content/headings) of your content
- adding [custom output formats](configuration/modifications/outputformats)

2
exampleSite/content/shortcodes/expand.en.md
View file

@ -49,7 +49,7 @@ That's some more text with a footnote.[^someid]
{{% /tab %}}
{{< /tabs >}}
The [`notice` shortcode](shortcodes/notice/) is also capable of displaying expandable/collapsible sections of text but with color options.
The [`notice` shortcode](shortcodes/notice) is also capable of displaying expandable/collapsible sections of text but with color options.
### Parameter

2
exampleSite/content/shortcodes/highlight.en.md
View file

@ -77,7 +77,7 @@ You are free to also call this shortcode from your own partials. In this case it
Codefence syntax is widely available in other Markdown parsers like GitHub and therefore is the recommend syntax for generating portable Markdown.
The [`tab` shortcode](shortcodes/tab/) is also capable of displaying code but with limited options.
The [`tab` shortcode](shortcodes/tab) is also capable of displaying code but with limited options.
### Parameter

2
exampleSite/content/shortcodes/math.en.md
View file

@ -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](content/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.

2
exampleSite/content/shortcodes/mermaid.en.md
View file

@ -104,7 +104,7 @@ You can force loading the Mermaid library if no shortcode or codefence was used
### Setting a Specific Mermaid Theme
While you can configure the Mermaid theme to render your graph by using one of the [initialization options](#providing-initialization-options-for-the-mermaid-library), the recommended way is to set the default value using the `--MERMAID-theme` variable in your [color variant stylesheet](configuration/appearance/generator/). This allows your graphs to look pretty when the user switches the color variant.
While you can configure the Mermaid theme to render your graph by using one of the [initialization options](#providing-initialization-options-for-the-mermaid-library), the recommended way is to set the default value using the `--MERMAID-theme` variable in your [color variant stylesheet](configuration/appearance/generator). This allows your graphs to look pretty when the user switches the color variant.
## Examples

4
exampleSite/content/shortcodes/openapi/_index.en.md
View file

@ -32,7 +32,7 @@ The `openapi` shortcode displays your OpenAPI / Swagger specifications using the
If you want to print out (or generate a PDF) from your OpenAPI documentation, don't initiate printing directly from the page because the elements are optimized for interactive usage in a browser.
Instead, open the [print preview](configuration/appearance/topbar/#print-support) in your browser and initiate printing from that page. This page is optimized for reading and expands most of the available sections.
Instead, open the [print preview](configuration/appearance/topbar#print-support) in your browser and initiate printing from that page. This page is optimized for reading and expands most of the available sections.
### Parameter
@ -71,7 +71,7 @@ You can force loading the Swagger UI library if no shortcode or codefence was us
### Setting a Specific Swagger UI Theme
The recommended way to configure your Swagger UI theme is to set the default value using the `--OPENAPI-theme` variable in your [color variant stylesheet](configuration/appearance/generator/). This allows your specs to look pretty when the user switches the color variant.
The recommended way to configure your Swagger UI theme is to set the default value using the `--OPENAPI-theme` variable in your [color variant stylesheet](configuration/appearance/generator). This allows your specs to look pretty when the user switches the color variant.
## Example

2
layouts/partials/version.txt
View file

@ -1 +1 @@
6.4.0+61ac26ac9bcc30b64832a5fd792386701a89bf9c
6.4.0+5b09d87984bbe384a79f8a52e0442fd0bf2d4ade