docs: add latest features

This commit is contained in:
Sören Weber 2022-02-14 21:44:01 +01:00
parent a48a7f540b
commit 8ddeec4b7a
No known key found for this signature in database
GPG key ID: 07D17FF580AE7589
5 changed files with 63 additions and 30 deletions

View file

@ -60,8 +60,8 @@ Note that some of these parameters are explained in details in other sections of
# Order sections in menu by "weight" or "title". Default to "weight";
# this can be overridden in the pages frontmatter
ordersectionsby = "weight"
# Change default color scheme with a variant one. Can be "red", "blue", "green" or an array like [ "blue", "green" ].
themeVariant = ""
# Change default color scheme with a variant one. Eg. can be "red", "blue", "green" or an array like [ "blue", "green" ].
themeVariant = "relearn-light"
# Provide a list of custom css files to load relative from the `static/` folder in the site root.
custom_css = ["css/foo.css", "css/bar.css"]
# Change the title separator. Default to "::".

View file

@ -9,20 +9,20 @@ In `themes/hugo-theme-relearn/layouts/partials/`, you will find all the partials
This theme defines the following partials :
- *content*: the content page itself. This can be overridden if you wan't to display page's meta data above or below the content.
- *header*: the header of the content page (contains the breadcrumbs). _Not meant to be overwritten_
- *custom-header*: custom headers in page. Meant to be overwritten when adding CSS imports. Don't forget to include `style` HTML tag directive in your file
- *footer*: the footer of the content page (contains the arrows). _Not meant to be overwritten_
- *custom-footer*: custom footer in page. Meant to be overwritten when adding Javacript. Don't forget to include `javascript` HTML tag directive in your file
- *favicon*: the favicon
- *logo*: the logo, on top left hand corner.
- *meta*: HTML meta tags, if you want to change default behavior
- *menu*: left menu. _Not meant to be overwritten_
- *menu-pre*: side-wide configuration to prepend to menu items. If you override this, it is your responsiblity to take the page's `pre` setting into account.
- *menu-post*: side-wide configuration to append to menu items. If you override this, it is your responsiblity to take the page's `post` setting into account.
- *menu-footer*: footer of the the left menu
- *search*: search box
- *toc*: table of contents
- `content.html`: the content page itself. This can be overridden if you wan't to display page's meta data above or below the content.
- `header.html`: the header of the content page (contains the breadcrumbs). _Not meant to be overwritten_
- `custom-header.html`: custom headers in page. Meant to be overwritten when adding CSS imports. Don't forget to include `style` HTML tag directive in your file
- `footer.html`: the footer of the content page (contains the arrows). _Not meant to be overwritten_
- `custom-footer.html`: custom footer in page. Meant to be overwritten when adding Javacript. Don't forget to include `javascript` HTML tag directive in your file
- `favicon.html`: the favicon
- `logo.html`: the logo, on top left hand corner
- `meta.html`: HTML meta tags, if you want to change default behavior
- `menu.html`: left menu. _Not meant to be overwritten_
- `menu-pre.html`: side-wide configuration to prepend to menu items. If you override this, it is your responsiblity to take the page's `pre` setting into account.
- `menu-post.html`: side-wide configuration to append to menu items. If you override this, it is your responsiblity to take the page's `post` setting into account.
- `menu-footer.html`: footer of the the left menu
- `search.html`: search box. _Not meant to be overwritten_
- `toc.html`: table of contents
## Change the logo
@ -53,17 +53,37 @@ The Relearn theme let you choose between some predefined color scheme variants,
```toml
[params]
# Change default color scheme with a variant one. Can be empty, "red", "blue", "green" or an array like [ "blue", "green" ].
themeVariant = ""
# Change default color scheme with a variant one.
themeVariant = "" # or themeVariant = "relearn" or themeVariant = "relearn-light"
```
![Red variant](images/standard-variant.png?width=60pc)
![Standard variant](images/standard-variant.png?width=60pc)
### Standard dark variant
```toml
[params]
# Change default color scheme with a variant one.
themeVariant = "relearn-dark"
```
![Dark variant](images/standard-dark-variant.png?width=60pc)
### Learn variant
```toml
[params]
# Change default color scheme with a variant one.
themeVariant = "learn"
```
![Learn variant](images/learn-variant.png?width=60pc)
### Red variant
```toml
[params]
# Change default color scheme with a variant one. Can be empty, "red", "blue", "green" or an array like [ "blue", "green" ].
# Change default color scheme with a variant one.
themeVariant = "red"
```
@ -73,7 +93,7 @@ The Relearn theme let you choose between some predefined color scheme variants,
```toml
[params]
# Change default color scheme with a variant one. Can be empty, "red", "blue", "green" or an array like [ "blue", "green" ].
# Change default color scheme with a variant one.
themeVariant = "blue"
```
@ -83,7 +103,7 @@ The Relearn theme let you choose between some predefined color scheme variants,
```toml
[params]
# Change default color scheme with a variant one. Can be empty, "red", "blue", "green" or an array like [ "blue", "green" ].
# Change default color scheme with a variant one.
themeVariant = "green"
```
@ -137,17 +157,16 @@ Then, set the `themeVariant` value with the name of your custom theme file. That
```toml
[params]
# Change default color scheme with a variant one. Can be "red", "blue", "green" or an array like [ "blue", "green" ].
# Change default color scheme with a variant one.
themeVariant = "mine"
```
### Multiple variants
You can also set multiple variants. In this case, the first variant is the default choosen on first view and a theme selector will be shown in the menu footer.
You can also set multiple variants. In this case, the first variant is the default choosen on first view and a theme switch will be shown in the menu footer.
```toml
[params]
# Change default color scheme with a variant one. Can be empty, "red", "blue", "green" or an array like [ "blue", "green" ].
themeVariant = [ "red", "blue ]
# Change default color scheme with a variant one.
themeVariant = [ "relearn-light", "relearn-dark" ]
```

Binary file not shown.

After

Width:  |  Height:  |  Size: 132 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 132 KiB

View file

@ -16,11 +16,25 @@ This document shows you what's new in the latest release. For a detailed list of
## 3.0.0
- **Breaking**: We made changes to the menu footer. If you have your `menu-footer.html` partial overridden, you may have to provide additional styling in your partial. For a reference take a look into the `menu-footer.html` partial that is coming with the exampleSite.
- **Breaking**: We made changes to the menu footer. If you have your `menu-footer.html` [partial overridden]({{%relref "basics/customization" %}}), you may have to provide additional styling 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).
- **New**: You can now set multiple color variants. In this case, the first variant is the default, choosen on first view and a theme selector will be shown in the menu footer. See the [documentation]({{%relref "basics/customization/#multiple-variants" %}}) for configuration.
- **Breaking**: We have changed the default colors from the original Learn theme (the purple menu header) to the Relearn defaults (the light greem menu header) as used in the official documentation.
This change will only affect your installation if you've not set the `themeVariant` parameter in your `config.toml`. [If you still want to use the Learn color variant]({{%relref "basics/customization/#learn-variant" %}}), you have to explicitly set `themeVariant="learn"` in your `config.toml`.
Note, that this will also affect your site if viewed with Internet Explorer 11 and can not reconfigured as it does not support CSS variables.
- **Change**: Due to a bug, that we couldn't fix in a general manner for all configurations, we decided to remove `--MENU-SEARCH-BOX-ICONS-color`.
- **New**: With this release we have introduced a lot more color variables you can use in [your color variants]({{%relref "basics/customization/#mine-variant" %}}). Your old variants will still work and don't need to be changed as apropriate default values are used by the theme. Nevertheless, the new colors allow for much more customization.
This feature was implemented to let the theme support dark color variants.
- **New**: You can now configure multiple color variants in your `config.toml`. In this case, the first variant is the default, choosen on first view and a theme switch will be shown in the menu footer. See the [documentation]({{%relref "basics/customization/#multiple-variants" %}}) for configuration.
Note, that the new theme switch will not work with Internet Explorer 11 as it does not support CSS variables.
## 2.9.0
@ -108,7 +122,7 @@ This document shows you what's new in the latest release. For a detailed list of
## 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.
- **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 the 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`.