Skip to content

Commit cb57b81

Browse files
committed
minor #1641 [Doc] Tweaks and fixes for UX Icons docs (javiereguiluz)
This PR was merged into the 2.x branch. Discussion ---------- [Doc] Tweaks and fixes for UX Icons docs | Q | A | ------------- | --- | Bug fix? | no | New feature? | no | Issues | - | License | MIT I think we should mention some of the popular icon sets so people googling for them and Symfony can find this page. Also, let's show the config file path in the config example. I'm not sure if we want that file path to be `config/packages/ux_icons.yaml` In #1602 we're making more changes to docs, so, if this PR is merged, I think it should be merged before #1602. Thanks! Commits ------- e3ac0a2 [Doc] Tweaks and fixes for UX Icons docs
2 parents 625a784 + e3ac0a2 commit cb57b81

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

src/Icons/doc/index.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
Symfony UX Icons
22
================
33

4-
Renders local and remote SVG icons in your Twig templates. It also gives direct
5-
access to over 200,000 open source vector icons from tens of icon sets.
4+
This package provides utilities to work with SVG icons. It renders both local
5+
and remote icons in your Twig templates. It provides direct access to over
6+
200,000 open source vector icons from popular icon sets such as FontAwesome,
7+
Bootstrap Icons, Tabler Icons, Google Material Design Icons, etc.
68

79
Installation
810
------------
@@ -114,7 +116,7 @@ the ``assets/icons/`` directory. You can think of importing an icon as *locking
114116
.. code-block:: terminal
115117
116118
# icon will be saved in `assets/icons/flowbite/user-solid.svg` and you can
117-
# use it name with the name: `flowbite:user-solid`
119+
# use it with the name: `flowbite:user-solid`
118120
$ php bin/console ux:icons:import flowbite:user-solid
119121
120122
# it's also possible to import several icons at once
@@ -168,6 +170,7 @@ Full Default Configuration
168170

169171
.. code-block:: yaml
170172
173+
# config/packages/ux_icons.yaml
171174
ux_icons:
172175
# The local directory where icons are stored.
173176
icon_dir: '%kernel.project_dir%/assets/icons'

0 commit comments

Comments
 (0)