nishiki/hugo-theme-relearn
1
0
Fork 0
mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2024-10-27 02:33:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

docs: honing #567

Browse source
This commit is contained in:
Sören Weber 2024-10-12 18:44:36 +02:00
parent e4e750c1cc
commit b581dbb6e5
No known key found for this signature in database
GPG key ID: BEC6D55545451B6D
4 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
exampleSite/content/authoring/frontmatter/navigationmenu/_index.en.md
View file

@ -18,11 +18,11 @@ If `alwaysopen=false` for any given entry, its children will not be shown in the
The theme generates the expand state based on the following rules: The theme generates the expand state based on the following rules:
- all parent entries of the active page including their visible siblings are shown regardless of any settings - all parent entries of the active page including their [visible](authoring/meta#hidden) siblings are shown regardless of any settings
- immediate child entries of the active page are shown regardless of any settings - immediate child entries of the active page are shown regardless of any settings
- if not overridden, all other first level entries behave like they would have been given `alwaysopen=false` - if not overridden, all other first level entries behave like they would have been given `alwaysopen=false`
- if not overridden, all other entries of levels besides the first behave like they would have been given `alwaysopen=true` - if not overridden, all other entries of levels besides the first behave like they would have been given `alwaysopen=true`
- all visible entries show their immediate child entries if `alwaysopen=true`; this proceeds recursively - all [visible](authoring/meta#hidden) entries show their immediate child entries if `alwaysopen=true`; this proceeds recursively
- all remaining entries are not shown - all remaining entries are not shown
## Expander for Nested Sections ## Expander for Nested Sections
@ -51,7 +51,7 @@ title = 'My page'
weight = 5 weight = 5
{{< /multiconfig >}} {{< /multiconfig >}}
### Other ### By Other
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} {{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} Using the `weight` for sorting can get cumbersome if you, for example, just want to sort alphabetically. Each time you add a new page in the set of pages, you may have to renumber some or all of them to make space for the new page. {{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} {{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} Using the `weight` for sorting can get cumbersome if you, for example, just want to sort alphabetically. Each time you add a new page in the set of pages, you may have to renumber some or all of them to make space for the new page.
@ -65,7 +65,7 @@ By default, the Relearn theme will use a page's `title` front matter for the men
{{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} 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. {{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} 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 `install/linux.md`): For example for a page named `install/linux.md`
{{< multiconfig fm=true >}} {{< multiconfig fm=true >}}
title = 'Install on Linux' title = 'Install on Linux'

2
exampleSite/content/configuration/sidebar/shortcutmenu/_index.en.md
View file

@ -2,7 +2,7 @@
description = "Add additional shortcut links to the sidebar" description = "Add additional shortcut links to the sidebar"
options = ["disableShortcutsTitle"] options = ["disableShortcutsTitle"]
title = "Shortcut Menu" title = "Shortcut Menu"
weight = 5 weight = 4
+++ +++
The sidebar contains your content's navigation menu, but you can also add extra menu entries or shortcuts in a separate section. The sidebar contains your content's navigation menu, but you can also add extra menu entries or shortcuts in a separate section.

2
exampleSite/content/configuration/sidebar/shortcutmenu/_index.pir.md
View file

@ -2,6 +2,6 @@
description = "Add additional shortcut links to the sidebar" description = "Add additional shortcut links to the sidebar"
options = ["disableShortcutsTitle"] options = ["disableShortcutsTitle"]
title = "Shortcut Menu" title = "Shortcut Menu"
weight = 5 weight = 4
+++ +++
{{< piratify >}} {{< piratify >}}

2
layouts/partials/version.txt
View file

@ -1 +1 @@
6.4.0+dcaeb1386051e27116d0a4039e26d832d9985c9e 6.4.0+e4e750c1cce67804f5bc889a71bc27024c922f4b