godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update Editor icons page to reflect usage of svgo (#10195)

Browse Source 
Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
This commit is contained in:
tetrapod
2024-11-04 13:09:06 -08:00
committed by Max Hilbrunner
parent 9f1060bb4a
commit 0f3b28f4d9
2 changed files with 5 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
contributing/development/code_style_guidelines.rst
View File

@@ -61,6 +61,8 @@ You need to use **clang-format 17** to be compatible with Godot's format. Later
be suitable, but previous versions may not support all used options, or format
some things differently, leading to style issues in pull requests.
.. _doc_code_style_guidelines_pre_commit_hook:
Pre-commit hook
^^^^^^^^^^^^^^^

21
contributing/development/editor/creating_icons.rst
View File

@@ -47,24 +47,9 @@ Icon optimization
~~~~~~~~~~~~~~~~~
Because the editor renders SVGs once at load time, they need to be small
in size so they can be efficiently parsed. Editor icons must be first
optimized before being added to the engine, to do so:
1. Install `svgcleaner <https://github.com/RazrFalcon/svgcleaner>`__
by downloading a binary from its
`Releases tab <https://github.com/RazrFalcon/svgcleaner/releases/latest>`__
and placing it into a location in your ``PATH`` environment variable.
2. Run the command below, replacing ``svg_source.svg`` with the path to your
SVG file (which can be a relative or absolute path):
.. code-block:: bash
svgcleaner --multipass svg_source.svg svg_optimized.svg
The ``--multipass`` switch improves compression, so make sure to include it.
The optimized icon will be saved to ``svg_optimized.svg``. You can also change
the destination parameter to any relative or absolute path you'd like.
in size so they can be efficiently parsed. When the
:ref:`pre-commit hook <doc_code_style_guidelines_pre_commit_hook>` runs, it automatically optimizes
the SVG using `svgo <https://github.com/svg/svgo>`_.
.. note::