mirror of
https://github.com/McShelby/hugo-theme-relearn
synced 2025-04-30 06:22:03 +08:00
docs: add information about what's stored in the readers browser #1070
This commit is contained in:
Sören Weber
parent
4b844a8acc
commit
da9ddd9c5a
@ -63,6 +63,9 @@ The first variant is the default, and a selector will appear if there's more tha
|
||||
|
||||
If you want to have more control, where the variant switcher is positioned or you want to configure a different icon, see the [chapter on sidebar configuration](configuration/sidebar/menus#defining-sidebar-menus).
|
||||
|
||||
> [!note]
|
||||
> The selected theme variant will be [stored in the reader's browser](configuration/sitemanagement/storedinformation).
|
||||
|
||||
#### Adjust to OS Settings
|
||||
|
||||
Use the `auto` value to match OS light/dark settings. Usually it makes sense to set it in the first position and make it the default.
|
||||
|
||||
@ -51,6 +51,9 @@ For a free configuration of the header menus, see [configuration of the sidebar
|
||||
|
||||
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} Turn on `showVisitedLinks=true` to see checkmarks next to visited pages in the main menu. This also adds a history clearer button at the bottom of the menu to remove all checkmarks.
|
||||
|
||||
> [!note]
|
||||
> The visited pages will be [stored in the reader's browser](configuration/sitemanagement/storedinformation).
|
||||
|
||||
If you want to have more control, where the history clearer is positioned or you want to configure a different icon, see the [chapter on sidebar configuration](configuration/sidebar/menus#defining-sidebar-menus).
|
||||
|
||||
Note that checkmarks will disappear if you rebuild your site, as the page IDs may change.
|
||||
|
||||
@ -16,6 +16,9 @@ The theme offers three levels of search through the menu's search form:
|
||||
|
||||
Each level requires the previous one to be enabled. If no search is configured, the search form won't appear.
|
||||
|
||||
> [!note]
|
||||
> The search term will be [stored in the reader's browser](configuration/sitemanagement/storedinformation) as long as it is present.
|
||||
|
||||
{{%badge style="cyan" icon="gears" title=" "%}}Option{{%/badge%}} All levels are enabled by default. Disable them in `hugo.toml`:
|
||||
|
||||
- In-page search: `disableSearch=true`
|
||||
|
||||
@ -3,7 +3,7 @@ categories = ['howto']
|
||||
description = 'What formats can a page be displayed in'
|
||||
outputs = ['html', 'rss', 'print', 'markdown', 'source']
|
||||
title = 'Available Output Formats'
|
||||
weight = 6
|
||||
weight = 7
|
||||
+++
|
||||
|
||||
The Relearn theme by default comes with templates for HTML and RSS for each page.
|
||||
|
||||
@ -3,6 +3,6 @@ categories = ['howto']
|
||||
description = 'What formats can a page be displayed in'
|
||||
outputs = ['html', 'rss', 'print', 'markdown', 'source']
|
||||
title = 'Available Output Formats'
|
||||
weight = 6
|
||||
weight = 7
|
||||
+++
|
||||
{{< piratify >}}
|
||||
@ -3,7 +3,7 @@ categories = ['howto']
|
||||
description = 'How to make your generated HTML output stable'
|
||||
options = ['disableAssetsBusting', 'disableGeneratorVersion', 'disableRandomIds', 'minify']
|
||||
title = 'Stable Output'
|
||||
weight = 7
|
||||
weight = 8
|
||||
+++
|
||||
|
||||
## Disabling the Generator Meta
|
||||
|
||||
@ -3,6 +3,6 @@ categories = ['howto']
|
||||
description = 'How to make your generated HTML output stable'
|
||||
options = ['disableAssetsBusting', 'disableGeneratorVersion', 'disableRandomIds', 'minify']
|
||||
title = 'Stable Output'
|
||||
weight = 7
|
||||
weight = 8
|
||||
+++
|
||||
{{< piratify >}}
|
||||
@ -0,0 +1,30 @@
|
||||
+++
|
||||
categories = ['explanation']
|
||||
description = "Information on what's stored on the reader's side"
|
||||
title = 'Stored Information'
|
||||
weight = 5
|
||||
+++
|
||||
|
||||
The theme will store information in the reader's browser. It is considered to fall under the exception clause in [DIRECTIVE 2002/58/EC OF THE EUROPEAN PARLIAMENT AND OF THE COUNCIL, Art. 5(3)](https://eur-lex.europa.eu/legal-content/EN/TXT/HTML/?uri=CELEX:02002L0058-20091219#id-8b90d9c9-eb09-44f5-a58d-51d9cb3a50cd).
|
||||
|
||||
> This shall not prevent any technical storage or access for the sole purpose of carrying out the transmission of a communication over an electronic communications network, or as strictly necessary in order for the provider of an information society service explicitly requested by the subscriber or user to provide the service.
|
||||
|
||||
The theme stores the following information in localstorage or sessionstorage.
|
||||
|
||||
- Currently applicable search term to carry over to the following presented pages. This will be used to mark the search term in the page's text.
|
||||
|
||||
This can be turned off by [disabling search](configuration/sidebar/search#configure-search).
|
||||
|
||||
- [Selected tab](shortcodes/tabs#behavior-of-the-groupid) of a tab group to apply the selection to other tab groups on the present page and all following presented pages.
|
||||
|
||||
This can not be turned off.
|
||||
|
||||
- Visited pages to show a check mark in the menu if the page was previously visited.
|
||||
|
||||
This can be turned off by [disabling the history](configuration/sidebar/headerfooter#history).
|
||||
|
||||
- The selected theme variant to carry over to the following presented pages.
|
||||
|
||||
This can be turned off by only having [one theme variant configured](configuration/branding/colors#single-variant).
|
||||
|
||||
The theme is not responsible for stored information of third-party-scripts (every library stored in subdirectories of `assets/js/`).
|
||||
@ -0,0 +1,7 @@
|
||||
+++
|
||||
categories = ['explanation']
|
||||
description = "Information on what's stored on the reader's side"
|
||||
title = 'Stored Information'
|
||||
weight = 5
|
||||
+++
|
||||
{{< piratify >}}
|
||||
@ -12,6 +12,8 @@ weight = -6
|
||||
|
||||
### New
|
||||
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} Information was added to the docs about the kind of [data the theme stores in the readers browser](configuration/sitemanagement/storedinformation).
|
||||
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The new [`tree` shortcode](shortcodes/tree) displays lists as nicely formatted trees with configurable icon and icon color.
|
||||
|
||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The [`icon` shortcode](shortcodes/icon) has learned the `style` and `color` options known from other shortcodes.
|
||||
|
||||
@ -105,6 +105,9 @@ See what happens to the tab views while you select different tabs.
|
||||
|
||||
While pressing a tab of Group A switches all tab views of Group A in sync (if the tab is available), the tabs of Group B are left untouched.
|
||||
|
||||
> [!note]
|
||||
> The selected tab will be [stored in the reader's browser](configuration/sitemanagement/storedinformation).
|
||||
|
||||
{{< tabs >}}
|
||||
{{% tab title="Group A, Tab View 1" %}}
|
||||
````go
|
||||
|
||||
@ -1 +1 @@
|
||||
7.5.0+b38321f619da16d489092b2d84b4b906680ad3d6
|
||||
7.5.0+4b844a8acc63f1cae8435a1be6a2ffb9c3886482
|
||||
Loading…
x
Reference in New Issue
Block a user