summaryrefslogtreecommitdiff
path: root/docs/modules
diff options
context:
space:
mode:
authorDan Allen <dan.j.allen@gmail.com>2022-08-18 04:16:29 -0600
committerDan Allen <dan.j.allen@gmail.com>2022-08-18 04:16:29 -0600
commit284ea075eee33ecb91b88d5c338adcebda116dd4 (patch)
tree0df1baf87350b1d045b7df166c9e644019a70a32 /docs/modules
parent8c0d31c92224e13eddb2714c13e24d41962251a2 (diff)
document the built-in padding added around a font-based admonition icon
Diffstat (limited to 'docs/modules')
-rw-r--r--docs/modules/theme/pages/admonition.adoc4
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/modules/theme/pages/admonition.adoc b/docs/modules/theme/pages/admonition.adoc
index 9e63fb47..3e59a52b 100644
--- a/docs/modules/theme/pages/admonition.adoc
+++ b/docs/modules/theme/pages/admonition.adoc
@@ -288,6 +288,10 @@ The keys in the `admonition-icon-<name>` category control the arrangement and st
All icon types must be grouped under a single `icon` category.
In other words, the `icon` category _cannot_ be declared multiple times and its keys _cannot_ be flattened (e.g., `tip-name: far-lightbulb` is not valid syntax).
+A font-based icon is placed in a container with a width 1.5 times the size of the icon.
+This is done to give the icon more padding than the textual label.
+This behavior will be configurable starting in Asciidoctor PDF 3.
+
The `image` key is only relevant when image-based icons are used (`icons=image`).
It's an alternative to using the `icon` attribute on the admonition block.
The path is resolved starting from the location of the AsciiDoc document and relative to the value of the `iconsdir` attribute.