Metadata-Version: 2.1
Name: render-engine-fontawesome
Version: 2024.1.1a1
Summary: add the fontawesome iconset
Project-URL: homepage, https://github.com/kjaymiller/render_engine_fontawesome
Project-URL: repository, https://github.com/kjaymiller/render_engine_fontawesome
Project-URL: documentation, https://github.io/kjaymiller/render_engine_fontawesome
Description-Content-Type: text/markdown
Requires-Dist: jinja2
Requires-Dist: render-engine>=2024.1.1a1
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: ruff; extra == "dev"

# Render Engine FontAwesome

Adds the fontawesome iconset to render engine themes.

Converts `<i class="fas fa-home"></i>` to <i class="fas fa-home"></i>.

## How to use this theme

1. Install the theme

   ```python
   pip install render_engine_fontawesome
   ```

2. Import the theme into your project

   ```python
   from render_engine import Site
   from render_engine_fontawesome import fontawesome

   app = Site()
   app.register_theme(fontawesome)
   app.site_vars['theme'].update({fontawesome: 'your token here'})
   ```

## Required Settings

Fontawesome now requires a token to be used. You can get a free token from [fontawesome.com](https://fontawesome.com/start).

The plugin looks for the `fontawesome` key in `site_vars['theme']` key. The value should be your token.
