Skip to content

[Doc] Tweaks and fixes for UX Icons docs #1641

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 21, 2024
Merged

[Doc] Tweaks and fixes for UX Icons docs #1641

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions src/Icons/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
Symfony UX Icons
================

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

Installation
------------
Expand Down Expand Up @@ -114,7 +116,7 @@ the ``assets/icons/`` directory. You can think of importing an icon as *locking
.. code-block:: terminal

# icon will be saved in `assets/icons/flowbite/user-solid.svg` and you can
# use it name with the name: `flowbite:user-solid`
# use it with the name: `flowbite:user-solid`
$ php bin/console ux:icons:import flowbite:user-solid

# it's also possible to import several icons at once
Expand Down Expand Up @@ -168,6 +170,7 @@ Full Default Configuration

.. code-block:: yaml

# config/packages/ux_icons.yaml
ux_icons:
# The local directory where icons are stored.
icon_dir: '%kernel.project_dir%/assets/icons'
Expand Down