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

docs: finalizing README for next release

Browse source
This commit is contained in:
Sören Weber 2022-03-15 20:59:24 +01:00
parent ff838d10de
commit 666bf335d0
No known key found for this signature in database
GPG key ID: 07D17FF580AE7589
4 changed files with 16 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
README.md
View file

@ -18,7 +18,8 @@ The theme is a fork of the great [Learn theme](https://github.com/matcornic/hugo
- Attachments files
- List child pages
- Mermaid diagram (flowchart, sequence, gantt)
- Customizable look and feel and theme variants
- Customizable look and feel
- Light, dark and various other predefined color variants
- Buttons
- Tip/Note/Info/Warning boxes
- Expand

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

@ -24,7 +24,8 @@ See [what's new]({{% relref "basics/migration" %}}) within the latest update.
* [Attachments files]({{%relref "shortcodes/attachments" %}})
* [List child pages]({{%relref "shortcodes/children" %}})
* [Mermaid diagram]({{%relref "shortcodes/mermaid" %}}) (flowchart, sequence, gantt)
* [Customizable look and feel and light or dark theme variants]({{%relref "basics/customization"%}})
* [Customizable look and feel]({{%relref "basics/customization"%}})
* [Predefined (light, dark) and customizable color variants]({{%relref "basics/generator" %}})
* [Buttons]({{%relref "shortcodes/button" %}})
* [Tip/Note/Info/Warning boxes]({{%relref "shortcodes/notice" %}})
* [Expand]({{%relref "shortcodes/expand" %}})

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

@ -14,6 +14,10 @@ This document shows you what's new in the latest release. For a detailed list of
---
## 3.1.0
- **New**: [`attachment`]({{% relref "shortcodes/attachments" %}}) and [`notice`]({{% relref "shortcodes/notice" %}}) shortcodes have a new parameter to override the default icon. Allowed values are all [Font Awesome 5 Free](https://fontawesome.com/v5/search?m=free) icons.
## 3.0.0
- **Breaking**: We made changes to the menu footer. If you have your `menu-footer.html` [partial overridden]({{%relref "basics/customization" %}}), you may have to review the styling (eg. margins/paddings) in your partial. For a reference take a look into the `menu-footer.html` partial that is coming with the exampleSite.
@ -26,7 +30,9 @@ This document shows you what's new in the latest release. For a detailed list of
Note, that this will also affect your site if viewed with Internet Explorer 11 but in this case it can not be reconfigured as Internet Explorer does not support CSS variables.
- **Change**: Due to a bug, that we couldn't fix in a general manner for color variants, we decided to remove `--MENU-SEARCH-BOX-ICONS-color`.
- **Change**: Due to a bug, that we couldn't fix in a general manner for color variants, we decided to removed `--MENU-SEARCH-BOX-ICONS-color` and introduced `--MENU-SEARCH-color` instead. You don't need to change anything in your custom color stylesheet as the old name will be used as a fallback.
- **Change**: For consistency reasons, we renamed `--MENU-SEARCH-BOX-color` to `--MENU-SEARCH-BORDER-color`. You don't need to change anything in your custom color stylesheet as the old name will be used as a fallback.
- **New**: With this release you are now capable to define your own *dark mode* variants.
@ -144,9 +150,9 @@ This document shows you what's new in the latest release. For a detailed list of
- **Change**: Syntaxhighlightning was switched to the [built in Hugo mechanism](https://gohugo.io/content-management/syntax-highlighting/). You may need to configure a new stylesheet or decide to roll you own as described on in the Hugo documentation
- **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**: In the predefined stylesheets there was a typo and `--MENU-HOME-LINK-HOVERED-color` must be changed to `--MENU-HOME-LINK-HOVER-color`. You don't need to change anything in your custom color stylesheet as the old name will be used as a fallback.
- **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**: `--MENU-HOME-LINK-color` and `--MENU-HOME-LINK-HOVER-color` were missing in the documentation. You should add them to your custom stylesheets if you want to override the defaults.
- **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.

6
exampleSite/content/cont/icons.en.md
View file

@ -7,9 +7,9 @@ The Relearn theme for Hugo loads the [**Font Awesome**](https://fontawesome.com)
## Finding an icon
Browse through the available icons in the [Font Awesome Gallery](https://fontawesome.com/icons?d=gallery&m=free). Notice that the **free** filter is enabled, as only the free icons are available by default.
Browse through the available icons in the [Font Awesome Gallery](https://fontawesome.com/v5/search?m=free). Notice that the **free** filter is enabled, as only the free icons are available by default.
Once on the Font Awesome page for a specific icon, for example the page for the [heart](https://fontawesome.com/icons/heart?style=solid), copy the HTML reference and paste into the Markdown content.
Once on the Font Awesome page for a specific icon, for example the page for the [heart](https://fontawesome.com/v5/icons/heart?s=solid), copy the HTML reference and paste into the Markdown content.
The HTML to include the heart icon is:
@ -33,7 +33,7 @@ Built with <i class="fas fa-heart"></i> by Relearn and Hugo
Font Awesome provides many ways to modify the icon
* Change colour (by default the icon will inherit the parent colour)
* Change color (by default the icon will inherit the parent color)
* Increase or decrease size
* Rotate
* Combine with other icons