mirror of
https://github.com/McShelby/hugo-theme-relearn
synced 2025-04-30 12:14:52 +08:00
docs: honing
This commit is contained in:
parent
14ad8e5292
commit
9412bd9cd5
@ -30,10 +30,11 @@ The Relearn theme is an enhanced fork of the popular [Learn theme](https://githu
|
|||||||
- **Advanced Functionality**
|
- **Advanced Functionality**
|
||||||
- [Chapter and site-wide printing capabilities](https://mcshelby.github.io/hugo-theme-relearn/configuration/sitemanagement/outputformats#print-support)
|
- [Chapter and site-wide printing capabilities](https://mcshelby.github.io/hugo-theme-relearn/configuration/sitemanagement/outputformats#print-support)
|
||||||
- [Versatile search options: in-page, popup, and dedicated search page](https://mcshelby.github.io/hugo-theme-relearn/configuration/sidebar/search)
|
- [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)
|
- [Customizable topbar buttons](https://mcshelby.github.io/hugo-theme-relearn/configuration/customization/topbar)
|
||||||
- [Configurable menus](https://mcshelby.github.io/hugo-theme-relearn/configuration/sidebar/menus)
|
- [Configurable sidebar menus](https://mcshelby.github.io/hugo-theme-relearn/configuration/sidebar/menus)
|
||||||
- [Support for hidden pages](https://mcshelby.github.io/hugo-theme-relearn/configuration/content/hidden)
|
- [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)
|
- [Comprehensive taxonomy support](https://mcshelby.github.io/hugo-theme-relearn/configuration/customization/taxonomy)
|
||||||
|
- [Versioning support](https://mcshelby.github.io/hugo-theme-relearn/configuration/sitemanagement/versioning)
|
||||||
- [Social media integration](https://mcshelby.github.io/hugo-theme-relearn/configuration/sitemanagement/meta#social-media-images)
|
- [Social media integration](https://mcshelby.github.io/hugo-theme-relearn/configuration/sitemanagement/meta#social-media-images)
|
||||||
|
|
||||||
- **Multilingual Support**
|
- **Multilingual Support**
|
||||||
|
@ -64,7 +64,7 @@ To setup versioning, you have to do the following steps:
|
|||||||
- `version` must be an `identifier` of one of the entries in the `versions` array
|
- `version` must be an `identifier` of one of the entries in the `versions` array
|
||||||
- you are not limited with the `baseURL`; these can be absolute or relative to your server root, can also reside in sub-subdirectories or be subdomains
|
- you are not limited with the `baseURL`; these can be absolute or relative to your server root, can also reside in sub-subdirectories or be subdomains
|
||||||
- you can generate your archived versions into a sub-directory of the current version (as with this example)
|
- you can generate your archived versions into a sub-directory of the current version (as with this example)
|
||||||
- if you generate your archived versions into a sub-directory take care in your workflow not to delete old archived versions during release of the current version
|
- if you generate your archived versions into a sub-directory take care in your workflow not to delete older archived versions during build
|
||||||
- the example does not take version control systems into account (like git or subversion) as such a workflow is highly subjective
|
- the example does not take version control systems into account (like git or subversion) as such a workflow is highly subjective
|
||||||
- both sites are completely independent autonomous Hugo sites; if you want to test this setup locally, you will need two running Hugo servers
|
- both sites are completely independent autonomous Hugo sites; if you want to test this setup locally, you will need two running Hugo servers
|
||||||
- if you want to test this locally, you will need to adept the top level `baseURL` parameter as well as the `baseURL` parameter in the `versions` array to your local setup; best is to have [preconfigured environment configs](https://gohugo.io/configuration/introduction/#configuration-directory) available
|
- if you want to test this locally, you will need to adept the top level `baseURL` parameter as well as the `baseURL` parameter in the `versions` array to your local setup; best is to have [preconfigured environment configs](https://gohugo.io/configuration/introduction/#configuration-directory) available
|
||||||
@ -158,7 +158,7 @@ To stay with the above example, here's the configuration for your current versio
|
|||||||
|
|
||||||
## Hiding the Versioning Warning
|
## Hiding the Versioning Warning
|
||||||
|
|
||||||
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} If visitors navigate to an old version of your site, they will see a versioning warning at the top of each page.
|
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} If visitors navigate to an archived version of your site, they will see a versioning warning at the top of each page.
|
||||||
|
|
||||||
You can disable it be setting the `disableVersioningWarning` option to `true` in your `hugo.toml`.
|
You can disable it be setting the `disableVersioningWarning` option to `true` in your `hugo.toml`.
|
||||||
|
|
||||||
@ -170,7 +170,7 @@ disableVersioningWarning = true
|
|||||||
|
|
||||||
### Method 1
|
### Method 1
|
||||||
|
|
||||||
You can adjust the text of the version warning by overriding the key `Versioning-warning` in your i18n files.
|
You can adjust the text of the versioning warning by overriding the key `Versioning-warning` in your i18n files.
|
||||||
|
|
||||||
The following parameter are available to be included in the text:
|
The following parameter are available to be included in the text:
|
||||||
|
|
||||||
|
@ -12,7 +12,7 @@ weight = -6
|
|||||||
|
|
||||||
### New
|
### New
|
||||||
|
|
||||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The theme [supports versioning](configuration/sitemanagement/versioning) now, were you can keep older versions of your site while showing a version switcher at the top of the menu.
|
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The theme [supports versioning](configuration/sitemanagement/versioning) now, where you can keep older versions of your site accessible via a version switcher at the top of the menu.
|
||||||
|
|
||||||
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The menu configuration for the main menu area, [introduced in 7.1.0](introduction/releasenotes/7/1), is extended to the non-scrolling menu header area between search box and main scrolling area using the `sidebarheadermenus` option and to the menu footer area using the `sidebarfootermenus` option.
|
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The menu configuration for the main menu area, [introduced in 7.1.0](introduction/releasenotes/7/1), is extended to the non-scrolling menu header area between search box and main scrolling area using the `sidebarheadermenus` option and to the menu footer area using the `sidebarfootermenus` option.
|
||||||
|
|
||||||
|
@ -1 +1 @@
|
|||||||
7.5.0+fae610dae90549aaac0ba396bd6f2a884ba65702
|
7.5.0+14ad8e5292e49a22804d346fa4923ca5e9f3aed8
|
@ -21,8 +21,9 @@ features = [
|
|||||||
'oas', 'offline usable', 'openapi', 'open graph',
|
'oas', 'offline usable', 'openapi', 'open graph',
|
||||||
'print', 'printable',
|
'print', 'printable',
|
||||||
'responsive', 'rss', 'rtl',
|
'responsive', 'rss', 'rtl',
|
||||||
'schema', 'search', 'search page', 'sidebar', 'sitemap', 'subtheme', 'swagger', 'swaggerui', 'syntax highlighting',
|
'schema', 'search', 'search page', 'sidebar', 'sidebar menus', 'sitemap', 'subtheme', 'swagger', 'swaggerui', 'syntax highlighting',
|
||||||
'table of contents', 'tab', 'tabs', 'tags', 'taxonomy', 'themeable', 'themes', 'toc', 'topbar buttons', 'twitter cards'
|
'table of contents', 'tab', 'tabs', 'tags', 'taxonomy', 'themeable', 'themes', 'toc', 'topbar buttons', 'twitter cards',
|
||||||
|
'versioning'
|
||||||
]
|
]
|
||||||
|
|
||||||
[module]
|
[module]
|
||||||
|
Loading…
x
Reference in New Issue
Block a user