Clarify icon_class behaviour

N-Parsons · Aug 8, 2019 · 72d673a · 72d673a
1 parent 76959b6
commit 72d673a
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 3 deletions.
diff --git 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
@@ -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.