nishiki/hugo-theme-relearn
1
0
Fork 0
mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2024-11-23 07:47:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

docs: what's new page #103

Browse source
This commit is contained in:
Sören Weber 2021-10-07 21:19:55 +02:00
parent fc7845df7d
commit 5d515e9d17
No known key found for this signature in database
GPG key ID: 07D17FF580AE7589
2 changed files with 61 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -12,6 +12,10 @@ The theme initially was a fork of the great [Learn theme](https://github.com/mat
## Main features ## Main features
{{% notice tip %}}
See [what's new]({{% relref "basics/migration" %}}) within the latest update.
{{% /notice %}}
* [Automatic Search]({{%relref "basics/configuration/_index.md#activate-search" %}}) * [Automatic Search]({{%relref "basics/configuration/_index.md#activate-search" %}})
* [Multilingual mode]({{%relref "cont/i18n" %}}) * [Multilingual mode]({{%relref "cont/i18n" %}})
* Unlimited menu levels * Unlimited menu levels

66
exampleSite/content/basics/migration/_index.en.md
View file

@ -1,18 +1,66 @@
+++ +++
title = "Migration" title = "What's new"
weight = 17 weight = 2
+++ +++
If you are upgrading from a previous version of the theme or even from the Learn theme, you may have to change a few things in your own installation. This document shows you what's new in the latest release. For a detailed list of changes, see the [history page]({{%relref "basics/history" %}}).
For a detailed list of changes, see the [history page]({{%relref "basics/history" %}}). **Breaking**: A change that requires action by you after upgrading to assure the site is still functional.
## From this theme **Change**: A change in default behavior. This may requires action by you / may or may not be revertable by configuration.
### Before 2.0.0 **New**: Marks new behavior you might find interesting or comes configurable.
- If you are using a [**custom** color variant](http://localhost:1313/basics/customization/#yours-variant), you may want to check your CSS file as there were [additions missing in the documenation](https://github.com/McShelby/hugo-theme-relearn/issues/45) ## 2.4.0
## From hugo-theme-learn - **Change**: Creation of customized stylesheets was simplified down to only contain the CSS variables. Everything else can and should be deleted from your custom stylesheet to assure everything works fine. For the predefined stylesheet variants, this change is already included. The [documentation]({{%relref "basics/customization/#mine-variant" %}}) was adjusted accordingly.
- If you are using a [**custom** color variant](http://localhost:1313/basics/customization/#yours-variant), you may want to check your CSS file as there were [additions missing in the documenation](https://github.com/McShelby/hugo-theme-relearn/issues/45) - **New**: Hidden pages are displayed by default in their according tags page. You can now turn off this behavior by setting `disableTagHiddenPages=true` in your `config.toml`.
- **New**: You can define the expansion state of your menus for the whole site by setting the `alwaysopen` option in your `config.toml`. Please see further [documentation]({{%relref "cont/pages/#override-expand-state-rules-for-menu-entries" %}}) for possible values and default behavior.
- **New**: New frontmatter `ordersectionsby` option to change immediate children sorting in menu and `children` shortcode. Possible values are `title` or `weight`.
- **New**: Alternate content of a page is now advertised in the HTML meta tags. See [Hugo documentation](https://gohugo.io/templates/rss/#reference-your-rss-feed-in-head).
## 2.2.0
- **New**: Hidden pages are displayed by default in the sitemap generated by Hugo and are therefore visible for search engine indexing. You can now turn off this behavior by setting `disableSeoHiddenPages=true` in your `config.toml`.
## 2.1.0
- **Change**: In case the site's structure contains addional *.md files not part of the site (eg files that are meant to be included by site pages - see CHANGELOG.md in exampleSite), they will now be ignored by the search.
- **New**: Hidden pages are indexed for the site search by default. You can now turn off this behavior by setting `disableSearchHiddenPages=true` in your `config.toml`.
- **New**: If a search term is found in an `expand` shortcode, the expand will be opened.
- **New**: The menu will scroll the active item into view on load.
## 2.0.0
- **Change**: In the predefined stylesheets there was a typo and `--MENU-HOME-LINK-HOVERED-color` must be changed to `--MENU-HOME-LINK-HOVER-color`.
- **Change**: `--MENU-HOME-LINK-color` and `--MENU-HOME-LINK-HOVER-color` were missing in the documentation. You should add them to your custom stylesheets.
- **Change**: Arrow navigation and `children` shortcode were ignoring setting for `ordersectionsby`. This is now changed and may result in different sorting order of your sub pages.
- **Change**: If hidden pages are accessed directly by typing their URL, they will be exposed in the menu.
- **Change**: A page without a `title` will be treated as `hidden=true`.
- **New**: You can define the expansion state of your menus in the frontmatter. Please see further [documentation]({{%relref "cont/pages/#override-expand-state-rules-for-menu-entries" %}}) for possible values and default behavior.
- **New**: New partials for defining pre/post content for menu items and the content. See [documentation]({{% relref "basics/customization" %}}) for further reading.
- **New**: Shortcode [`children`]({{% relref "shortcodes/children" %}}) with new parameter `containerstyle`.
- **New**: New shortcode [`include`]({{% relref "shortcodes/include" %}}) to include arbitrary file content into a page.
## 1.2.0
- **New**: Shortcode [`expand`]({{% relref "shortcodes/expand" %}}) with new parameter to open on page load.
## 1.1.0
- **New**: [`Mermaid`]({{% relref "shortcodes/mermaid#configuration" %}}) config options can be set in `config.toml`.