Skip to content
forked from svg/svgo

SVGO is a Nodejs-based tool for optimizing SVG vector graphics files.

License

Notifications You must be signed in to change notification settings

st937072012/svgo

Repository files navigation

o-o o   o o--o o-o
 \   \ /  |  | | |
o-o   o   o--o o-o
             |
          o--o

SVGO v0.0.9 Build Status

SVG Optimizer is a Nodejs-based tool for optimizing SVG vector graphics files.

Why?

SVG files, especially exported from various editors, usually contains a lot of redundant and useless information such as editor metadata, comments, hidden elements, default or non-optimal values and other stuff that can be safely removed or converted without affecting SVG rendering result.

What it can do

SVGO has a plugin-based architecture, so almost every optimization is a separate plugin.

Today we have:

  • [ > ] cleanup attributes from newlines, trailing and repeating spaces
  • [ > ] remove doctype declaration
  • [ > ] remove XML processing instructions
  • [ > ] remove comments
  • [ > ] remove metadata
  • [ > ] remove editors namespaces, elements and attributes
  • [ > ] remove empty attributes
  • [ > ] remove default "px" unit
  • [ > ] remove a lot of hidden elements
  • [ > ] remove empty Text elements
  • [ > ] remove empty Container elements
  • [ > ] remove viewBox attribute
  • [ > ] remove or cleanup enable-background attribute
  • [ > ] cleanup SVG element from useless attributes
  • [ > ] convert styles into attributes
  • [ > ] convert colors (from rgb() to #rrggbb, from #rrggbb to #rgb)
  • [ > ] convert Path data to relative, trim useless delimiters and much more
  • [ > ] collapse multiple transforms into one, convert matrices to the short aliases and much more
  • [ > ] remove unused namespaces declaration
  • [ > ] move elements attributes to the existing group wrapper
  • [ > ] collapse groups

Want to know how it works and how to write your own plugin? Of course you want to.

How to use

npm install -g svgo
Usage:
  svgo [OPTIONS] [ARGS]

Options:
  -h, --help : Help
  -v, --version : Version
  -i INPUT, --input=INPUT : Input: stdin (default) | filename | Data URI base64 string
  -o OUTPUT, --output=OUTPUT : Output: stdout (default) | filename
  -c CONFIG, --config=CONFIG : Local config file to extend default
  --disable=DISABLE : Disable plugin by name
  --enable=ENABLE : Enable plugin by name
  --datauri : Output as Data URI base64 string
  --pretty : Make SVG pretty printed
  --test : Make a visual comparison of two files (PhantomJS pre-required)

With files:

svgo -i test.svg -o test.min.svg

With stdin / stdout:

cat test.svg | svgo > test.min.svg

With Data URI base64 strings:

svgo -i 'data:image/svg+xml;base64,…' -o test.min.svg

TODO

  1. batch folder optimization
  2. more plugins
  3. SVGO GUI (crossplatform?) via awesome node-webkit
  4. online SVGO web service
  5. more unit tests

About

SVGO is a Nodejs-based tool for optimizing SVG vector graphics files.

Resources

License

Stars

Watchers

Forks

Packages

No packages published