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: minor tweaks #410 #412

Browse source
This commit is contained in:
Sören Weber 2022-12-02 19:26:49 +01:00
parent 350f7abd7f
commit 20b5175214
No known key found for this signature in database
GPG key ID: BEC6D55545451B6D
2 changed files with 14 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
exampleSite/content/shortcodes/badge.en.md
View file

@ -184,8 +184,12 @@ You can combine the badge with the [`icon` shortcode]({{% relref "shortcodes/ico
In this case you need to declare `{{</* badge */>}}` instead of `{{%/* badge */%}}`. Note, that in this case it is not possible to put markdown in the content.
````go
{{</* badge style="primary" icon="angle-double-up" >}}{{% icon skull-crossbones %}}{{< /badge */>}}
{{</* badge style="primary" icon="angle-double-up" >}}{{% icon skull-crossbones %}} Pirate{{< /badge */>}}
{{</* badge style="primary" title="Rank" >}}{{% icon skull-crossbones %}}{{< /badge */>}}
{{</* badge style="primary" title="Rank" >}}{{% icon skull-crossbones %}} Pirate{{< /badge */>}}
{{</* badge style="primary" icon="angle-double-up" title="Rank" >}}{{% icon skull-crossbones %}}{{< /badge */>}}
{{</* badge style="primary" icon="angle-double-up" title="Rank" >}}{{% icon skull-crossbones %}} Pirate{{< /badge */>}}
````
{{< badge style="primary" icon="angle-double-up" >}}{{% icon skull-crossbones %}}{{< /badge >}}

6
exampleSite/content/shortcodes/icon.en.md
View file

@ -61,13 +61,13 @@ While the examples are using shortcodes with positional parameter you are free t
|:----------------------|:---------|:----------------|:------------|
| **icon** | 1 | _&lt;empty&gt;_ | [Font Awesome icon name]({{%relref "#finding-an-icon" %}}) to be displayed. It will be displayed in the text color of its according context. |
## Finding an icon
### Finding an icon
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/v5/icons/heart?s=solid), copy the icon name and paste into the Markdown content.
## Customising Icons
### Customising Icons
Font Awesome provides many ways to modify the icon
@ -80,7 +80,7 @@ Check the full documentation on [web fonts with CSS](https://fontawesome.com/how
## Examples
### Standard Use
### Standard Usage
````go
Built with {{%/* icon heart */%}} by Relearn and Hugo