From 72d673ab1ffa5bf5a9d67fb97589ec963cbeef0a Mon Sep 17 00:00:00 2001 From: Nathan Parsons Date: Thu, 8 Aug 2019 13:25:21 +0100 Subject: [PATCH] Clarify icon_class behaviour --- CHANGELOG.md | 3 +-- README.md | 2 +- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5db1a2a..b47c8c4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,7 +1,6 @@ # v0.1.0 -## 2019-08-06 +## 2019-08-08 1. [](#new) * Implemented embedding of Font Awesome icons and custom icons. * Added methods for including custom icons in pages. - diff --git a/README.md b/README.md index 6e4d5ae..0d45598 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ The `embed-fontawesome.yaml` file contains the following configuration options: - `enabled` (bool): Enables/disables the plugin. - `builtin_css` (bool): Enables/disables loading of the builtin CSS. - `fail_behaviour` (`hard`/`soft`): Behaviour when icon files are missing (`hard` => throw an exception, `soft` => replace the icon with a question mark). -- `icon_class` (text): Class(es) to assign to the inline SVG icons. +- `icon_class` (text): Class(es) to assign to the inline SVG icons (multiple classes should be space-separated). - `retain_icon_name` (bool): Whether to retain the icon name as a class of the icon (eg. `fa-heart`). - `emoji_icons` (bool): Whether to enable the :emoji:-syntax for custom icons. - `shortcode_icons` (bool): Whether to enable the `[icon=.../]` shortcode for custom icons.