Skip to content

Commit

Permalink
minor #2163 [Icons] add versionadded for Icon Aliases to doc (kbond)
Browse files Browse the repository at this point in the history
This PR was merged into the 2.x branch.

Discussion
----------

[Icons] add versionadded for Icon Aliases to doc

| Q             | A
| ------------- | ---
| Bug fix?      | no
| New feature?  | no
| Issues        | n/a
| License       | MIT

Commits
-------

4d03d40 doc: add versionadded to Icon Aliases
  • Loading branch information
smnandre committed Sep 14, 2024
2 parents 781f66c + 4d03d40 commit 7674015
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions src/Icons/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -339,6 +339,10 @@ Now, all icons will have the ``fill`` attribute set to ``currentColor`` by defau
Icon Aliases
~~~~~~~~~~~~

.. versionadded:: 2.20

Icon Aliases feature was added in 2.20.

Aliases are custom names you can define to refer to any icon. They are useful for
creating shortcuts to icons you frequently use in your templates:

Expand Down Expand Up @@ -544,11 +548,11 @@ Full Configuration
default_icon_attributes:
# Default:
fill: currentColor
# Icon aliases (alias => icon name).
aliases:
# Exemple:
dots: 'clarity:ellipsis-horizontal-line'
dots: 'clarity:ellipsis-horizontal-line'
# Configuration for the "on demand" icons powered by Iconify.design.
iconify:
Expand All @@ -559,7 +563,7 @@ Full Configuration
# The endpoint for the Iconify API.
endpoint: 'https://api.iconify.design'
# Whether to ignore errors when an icon is not found.
ignore_not_found: false
Expand Down

0 comments on commit 7674015

Please # to comment.