nishiki/hugo-theme-relearn
1
0
Fork 0
mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2025-01-31 08:57:15 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: polish

Browse source
This commit is contained in:
Sören Weber 2023-09-18 20:53:46 +02:00
parent e065239498
commit 8b88d6625d
No known key found for this signature in database
GPG key ID: BEC6D55545451B6D
2 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -20,7 +20,7 @@ This document shows you what's new in the latest release. For a detailed list of
## 5.21.0 (2023-09-03) {#5210}
- {{% badge style="note" title=" " %}}Change{{% /badge %}} We made changes to the menu footer improve alignment with the menu items in most cases. Care was taken not to break your existing overwritten footer. Anyways, if you have your `menu-footer.html` [partial overridden]({{%relref "basics/customization" %}}), you may want to review the styling (eg. margins/paddings) of your partial.
- {{% badge style="note" title=" " %}}Change{{% /badge %}} We made changes to the menu footer to improve alignment with the menu items in most cases. Care was taken not to break your existing overwritten footer. Anyways, if you have your `menu-footer.html` [partial overridden]({{%relref "basics/customization" %}}), you may want to review the styling (eg. margins/paddings) of your partial.
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} This release comes with an awesome new feature, that allows you to customize your topbar buttons, change behavior, reorder them or define entirely new ones, unique to your installation. See [the documentation]({{%relref "basics/topbar" %}}) for further details.

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

@ -68,9 +68,9 @@ Depending on the screen width you can configure how the button should behave. Sc
For each width class, you can configure one of the following actions:
- **show**: the button is displayed in its configured area
- **hide**: the button is hidden
- **area-XXX**: the button is moved from its configured area into the area `XXX`; eg. this is used to move buttons to the _more_ area in the mobile layout
- `show`: the button is displayed in its configured area
- `hide`: the button is hidden
- `area-XXX`: the button is moved from its configured area into the area `XXX`; eg. this is used to move buttons to the _more_ area in the mobile layout
#### Hiding and Disabling Stuff
@ -82,8 +82,8 @@ Another prefered condition for hiding a button is, if the displayed overlay is e
This parameter can have one of the following values:
- **hide**: the button is hidden if the overlay is empty
- **disable**: the button is disabled if the overlay is empty
- `hide`: the button is hidden if the overlay is empty
- `disable`: the button is disabled if the overlay is empty
If you want to disable a button containing _no overlay_, this can be achieved by an empty `href` parameter. An example can be seen in the _prev_ button (see `layouts/partials/topbar/button/prev.html`) where the URL for the previous site may be empty.
@ -130,7 +130,7 @@ The predefined buttons by the theme (all other buttons besides the _more_ and _t
| Name | Default | Notes |
|-----------------------|-------------------|-------------|
| **page** | _<empty>_ | Mandatory reference to the page. |
| **onwidths** | _&lt;varying&gt;_ | The action, that should be executed if the site is displayed in the given width:<br><br>- `show`: The button is displayed in its configured area<br>- `hide_&lt;varying&gt;_ is hidden.<br>- `area-XXX`: The button is moved from its configured area into the area `XXX`. |
| **onwidths** | _&lt;varying&gt;_ | The action, that should be executed if the site is displayed in the given width:<br><br>- `show`: The button is displayed in its configured area<br>- `hide`: The button is hidden.<br>- `area-XXX`: The button is moved from its configured area into the area `XXX`. |
| **onwidthm** | _&lt;varying&gt;_ | See above. |
| **onwidthl** | _&lt;varying&gt;_ | See above. |