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

docs: fine tuning

Browse source
This commit is contained in:
Sören Weber 2023-06-08 00:10:37 +02:00
parent f52639c9df
commit 619e8846d4
No known key found for this signature in database
GPG key ID: BEC6D55545451B6D
3 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/shortcodes/siteparam.en.md
View file

@ -1,6 +1,6 @@
+++ +++
description = "Get value of site params" description = "Get value of site params"
title = "Site param" title = "Site Param"
+++ +++
The `siteparam` shortcode prints values of site params. The `siteparam` shortcode prints values of site params.

2
exampleSite/content/shortcodes/siteparam.pir.md
View file

@ -1,5 +1,5 @@
+++ +++
descrption = "Get value o' ship parrrams varrriables 'n yer plank" descrption = "Get value o' ship parrrams varrriables 'n yer plank"
title = "Ship param" title = "Ship Param"
+++ +++
{{< piratify >}} {{< piratify >}}

10
exampleSite/content/shortcodes/tabs.en.md
View file

@ -96,7 +96,7 @@ printf"Hello World!");
| **groupid** | _&lt;random&gt;_ | Arbitrary name of the group the tab view belongs to.<br><br>Tab views with the same **groupid** sychronize their selected tab. The tab selection is restored automatically based on the `groupid` for tab view. If the selected tab can not be found in a tab group the first tab is selected instead.<br><br>This sychronization applies to the whole site! | | **groupid** | _&lt;random&gt;_ | Arbitrary name of the group the tab view belongs to.<br><br>Tab views with the same **groupid** sychronize their selected tab. The tab selection is restored automatically based on the `groupid` for tab view. If the selected tab can not be found in a tab group the first tab is selected instead.<br><br>This sychronization applies to the whole site! |
| **style** | _&lt;empty&gt;_ | Sets a default value for every contained tab. Can be overridden by each tab. See the [`tab` shortcode]({{% relref "shortcodes/tab#parameter" %}}) for possible values. | | **style** | _&lt;empty&gt;_ | Sets a default value for every contained tab. Can be overridden by each tab. See the [`tab` shortcode]({{% relref "shortcodes/tab#parameter" %}}) for possible values. |
| **color** | _&lt;empty&gt;_ | Sets a default value for every contained tab. Can be overridden by each tab. See the [`tab` shortcode]({{% relref "shortcodes/tab#parameter" %}}) for possible values. | | **color** | _&lt;empty&gt;_ | Sets a default value for every contained tab. Can be overridden by each tab. See the [`tab` shortcode]({{% relref "shortcodes/tab#parameter" %}}) for possible values. |
| **title** | _&lt;empty&gt;_ | Arbitrary title written in front of the tabs. | | **title** | _&lt;empty&gt;_ | Arbitrary title written in front of the tab view. |
| **icon** | _&lt;empty&gt;_ | [Font Awesome icon name]({{%relref "shortcodes/icon#finding-an-icon" %}}) set to the left of the title. | | **icon** | _&lt;empty&gt;_ | [Font Awesome icon name]({{%relref "shortcodes/icon#finding-an-icon" %}}) set to the left of the title. |
| _**&lt;content&gt;**_ | _&lt;empty&gt;_ | Arbitrary number of tabs defined with the `tab` sub-shortcode. | | _**&lt;content&gt;**_ | _&lt;empty&gt;_ | Arbitrary number of tabs defined with the `tab` sub-shortcode. |
@ -106,7 +106,7 @@ printf"Hello World!");
See what happens to the tab views while you select different tabs. See what happens to the tab views while you select different tabs.
While pressing a tab of group A switches all tab views of group A in sync (if the tab is available), the tabs of group B are left untouched. While pressing a tab of Group A switches all tab views of Group A in sync (if the tab is available), the tabs of Group B are left untouched.
{{< tabs >}} {{< tabs >}}
{{% tab title="Group A, Tab View 1" %}} {{% tab title="Group A, Tab View 1" %}}
@ -213,11 +213,11 @@ While pressing a tab of group A switches all tab views of group A in sync (if th
{{% /tab %}} {{% /tab %}}
{{< /tabs >}} {{< /tabs >}}
### Nested Tabs and Color ### Nested Tab Views and Color
In case you want to nest tabs, the parent tab that contains the subtabs needs to be declared with `{{</* tab */>}}` instead of `{{%/* tab */%}}`. Note, that in this case it is not possible to put markdown in the parent tab. In case you want to nest tab views, the parent tab that contains nested tab views needs to be declared with `{{</* tab */>}}` instead of `{{%/* tab */%}}`. Note, that in this case it is not possible to put markdown in the parent tab.
You can also set various color parameter for all tabs or just selected ones. See the [`tab` shortcode]({{% relref "shortcodes/tab#parameter" %}}) for possible values. You can also set style and color parameter for all tabs and overwrite them on tab level. See the [`tab` shortcode]({{% relref "shortcodes/tab#parameter" %}}) for possible values.
````go ````go
{{</* tabs groupid="main" style="primary" title="Rationale" icon="thumbtack" */>}} {{</* tabs groupid="main" style="primary" title="Rationale" icon="thumbtack" */>}}