Skip to content

Latest commit

 

History

History
53 lines (31 loc) · 1.68 KB

README.md

File metadata and controls

53 lines (31 loc) · 1.68 KB
Raw

SvgSpriter

Take a directory of SVG files, optimize them, and compile them into a single sprite file using <symbol> elements.

Use case for SVG sprites: https://css-tricks.com/svg-sprites-use-better-icon-fonts

This gem is based off svg-sprite for npm. It will allow you to use SVG sprites while only maintaining one instance of an SVG. Originally built for Nanoc to build a sprite when compiling site, but can be used in any Ruby application that can compile a site.

Installation

Add this line to your application’s Gemfile:

gem 'svg_spriter'

And then execute:

$ bundle

Or install it yourself as:

$ gem install svg_spriter

Usage

During compiling, run:

sprite_svg(source: 'source', output: 'output')

where source is something like /static/svg. Output is optional, and will use the source if not specified.

TODO

  • Allow for more robust SVGs. Currently only simple SVGs compile reliably
  • Allow for subdirectories of source directory
  • Add more tests for checking integrity of compiled sprite
  • Handle SVGs with duplicate ids
  • Pull id from filename if none is specified within the opening <svg> tag

Author’s note

This is my first RubyGem, and my experience with Ruby is limited. This was a way for me to learn more about Ruby and RubyGems, and I don't pretend to know the best way to do things in Ruby. So, any contributions or suggestions for this gem are appreciated.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/cinnamonkale/svg_spriter.

License

The gem is available as open source under the terms of the MIT License.