summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorzyuhel <zyuhel@users.noreply.github.com>2019-04-11 14:53:13 +0300
committerDan Allen <dan.j.allen@gmail.com>2019-04-12 23:58:47 -0600
commit2099eba9f633dbccddc7b01b6c54ac450bae752f (patch)
treef5da01c41c4ab940bb83052b21e693ccf021d861 /docs
parent003fb0ffe39ed9faed849a0822e2b739a97276c2 (diff)
resolves #891 upgrade to FontAwesome 5
* Update `prawn-icon` to version `2.3.0`. This update upgrades FontAwesome from version 4 to 5. * Update the list of supported icon fonts to include the FontAwesome categories (`solid => fas`, `brands => fab` and `regular => far`). * The `fa-*` prefix may still be used to generate icons, but a deprecation warning will be printed prompting to use the Font Awesome 5 font categories. * Use `make_icon` to create an icon instance so that Prawn::Icon's FA4 => FA5 mapping functions as expected (as opposed calling Prawn::Icon::FontData.load`. * Setup `fas` to be the default font family (FontAwesome solid). * Remove all references to the `octicon` font. It is no longer included in `prawn/icon`. * Create `play_icon` helper method in the extensions module to to return a icon node when icon fonts are enabled. * Update documentation and guides that are applicable to icon styling. * Regenerate the `examples/chronicles-example.pdf` file to include new icons.
Diffstat (limited to 'docs')
-rw-r--r--docs/theming-guide.adoc6
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/theming-guide.adoc b/docs/theming-guide.adoc
index c3dd20c6..b926ee7f 100644
--- a/docs/theming-guide.adoc
+++ b/docs/theming-guide.adoc
@@ -2303,7 +2303,7 @@ The keys in this category control the arrangement and style of admonition blocks
|admonition:
icon:
tip:
- name: fa-fire
+ name: fas-fire
|stroke_color
|<<colors,Color>> +
@@ -2324,10 +2324,10 @@ The keys in this category control the arrangement and style of admonition blocks
. The top and bottom padding values are ignored on admonition_label_padding.
. `<name>` can be `note`, `tip`, `warning`, `important`, or `caution`.
-The subkeys in the icon category cannot be flattened (e.g., `tip_name: fa-lightbulb-o` is not valid syntax).
+The subkeys in the icon category cannot be flattened (e.g., `tip_name: far-lightbulb` is not valid syntax).
. Required.
See the `.yml` files in the https://github.com/jessedoyle/prawn-icon/tree/master/data/fonts[prawn-icon repository] for a list of valid icon names.
-The prefix (e.g., `fa-`) determines which font set to use.
+The prefix (e.g., `fas-`) determines which font set to use.
[#keys-image]
=== Image