midtowndrafting.com/content/docs/guide/shortcodes/icon.md
2024-05-03 19:04:48 -04:00

962 B

title
Icon

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.