forked from drowl87/hextra_mirror
1c7962494d
fix: hide lang switch if site is not multilingual docs: update getting started page fix: ordered list style chore: update hugo icon feat: add icon shortcode page docs: add markdown and configuration pages docs: add diagrams page docs: add more content fix: mermaid background and add image styling chore: update templates chore: update hugo stats
39 lines
706 B
Markdown
39 lines
706 B
Markdown
---
|
|
title: Icon
|
|
---
|
|
|
|
To use this shortcode inline, make sure you have enabled the inline shortcode in the config:
|
|
|
|
```yaml {filename="hugo.yaml"}
|
|
enableInlineShortcodes: true
|
|
```
|
|
|
|
The list of available icons can be found in `data/icon.yaml`.
|
|
|
|
## Example
|
|
|
|
{{< icon "academic-cap" >}}
|
|
{{< icon "cake" >}}
|
|
{{< icon "gift" >}}
|
|
{{< icon "sparkles" >}}
|
|
|
|
## Usage
|
|
|
|
```
|
|
{{</* icon "github" */>}}
|
|
```
|
|
|
|
[Heroicons](https://v1.heroicons.com/) v1 outline icons are available out of the box.
|
|
|
|
You can also add your own icons by adding them to `data/icon.yaml`:
|
|
|
|
```yaml {filename="data/icon.yaml"}
|
|
your-icon: <svg>your icon svg content</svg>
|
|
```
|
|
|
|
which can then be used like this:
|
|
|
|
```
|
|
{{</* icon "your-icon" */>}}
|
|
```
|