example.qmd

---
title: Font Awesome Quarto Extension
format:
   html: default
   pdf: default
---

This extension allows you to use font-awesome icons in your Quarto HTML and PDF documents.
It provides an `{{{< fa >}}}` shortcode:

- Mandatory `<icon-name>`:
  ``` markdown
  {{{< fa <icon-name> >}}}
  ```

- Optional `<group>`, `<size=...>`, and `<title=...>`:
  ``` markdown
  {{{< fa <group> <icon-name> <size=...> <title=...> >}}}
  ```

For example:

| Shortcode                                          | Icon                                      |
| -------------------------------------------------- | ----------------------------------------- |
| `{{{< fa thumbs-up >}}}`                           | {{< fa thumbs-up >}}                      |
| `{{{< fa folder >}}}`                              | {{< fa folder >}}                         |
| `{{{< fa chess-pawn >}}}`                          | {{< fa chess-pawn >}}                     |
| `{{{< fa brands bluetooth >}}}`                    | {{< fa brands bluetooth >}}               |
| `{{{< fa brands twitter size=2xl >}}}` (HTML only) | {{< fa brands twitter size=2xl >}}        |
| `{{{< fa brands github size=5x >}}}` (HTML only)   | {{< fa brands github size=5x >}}          |
| `{{{< fa battery-half size=Huge >}}}`              | {{< fa battery-half size=Huge >}}         |
| `{{{< fa envelope title="An envelope" >}}}`        | {{< fa envelope title="An envelope" >}}   |

Note that the icon sets are currently not perfectly interchangeable across formats:

- `html` uses FontAwesome 6.4.2
- `pdf` uses the `fontawesome5` package, based on [FontAwesome 5](https://ctan.org/pkg/fontawesome5).
- Other formats are currently not supported, but PRs are always welcome!