Files
kirby-fontawesome/README.md
2026-04-17 03:19:57 +10:00

32 lines
1.5 KiB
Markdown

# Kirby Font Awesome
A plugin for [Kirby](https://getkirby.com) to load the [Font Awesome](https://fontawesome.com) assets via the `getAssets()` hook of the [Kirby Library](https://git.hobbyhome.net/HobbyHome/kirby-library) plugin.
## KirbyTag
```
<?= kirbytag("fa", "icon", ["fastyle" => "regular"]) ?>
<i class="fa-classic fa-regular fa-icon"></i>
```
Supports the following attributes:
- **style** - Inline CSS style to apply to the icon.
- **class** - CSS classes to apply to the icon.
- **family** - The Font Awesome family of icon.
- **fastyle** - The Font Awesome style of icon.
- **title** - A title to add to the icon. Useful for tooltips.
# License
Kirby Font Awesome is Copyright 2026, [Dreytac](mailto:dreytac@hobbyhome.net).
Kirby Font Awesome is free software: you can redistribute it and/or modify it under the terms of the [GNU Affero General Public License version 3](LICENSE.md) as published by the Free Software Foundation.
Kirby Font Awesome is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
[Font Awesome](https://fontawesome.com) free icons are licensed under the [Creative Commons Attribution 4.0 International License](LICENSE-FONTAWESOME.txt).
[Font Awesome](https://fontawesome.com) free fonts are licensed under the [SIL Open Font License, Version 1.1](LICENSE-FONTAWESOME.txt).