mirror of
https://github.com/imfing/hextra.git
synced 2025-11-01 23:15:20 -04:00
83f3b5052e
* chore(docs): rename `exampleSite` to `docs` and create `examples` * chore(build): update build script to support new version format and source directories; add v0.10 to documentation menu
1.2 KiB
1.2 KiB
title, next
| title | next |
|---|---|
| Icon | /docs/guide/shortcodes/steps |
To use this shortcode inline, inline shortcode needs to be enabled in the config:
enableInlineShortcodes: true
List of available icons can be found in data/icons.yaml.
Example
{{< icon "academic-cap" >}} {{< icon "cake" >}} {{< icon "gift" >}} {{< icon "sparkles" >}}
Usage
{{</* icon "github" */>}}
Heroicons v1 outline icons are available out of the box.
How to add your own icons
Create data/icons.yaml file, then add your own SVG icons in the following format:
your-icon: <svg>your icon svg content</svg>
It then can be used in the shortcode like this:
{{</* icon "your-icon" */>}}
{{</* card icon="your-icon" */>}}
Tip: Iconify Design is a great place to find SVG icons for your site.
Options
| Name | Description |
|---|---|
name |
Icon name |
attributes |
The attributes of the icon. |