Project

savagery

0.0
No commit activity in last 3 years
No release in over 3 years
Ruthlessly sprites SVGs
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

 Project Readme

Savagery

Ruthlessly sprite SVGs in your Rails app.

Installation

Add this line to your application's Gemfile:

gem "savagery"

Usage

Given the following directory structure:

app/assets/svgs/
└── dogs
    ├── chihuahua.svg
    ├── golden.svg
    └── lab.svg

Rails: Use the svg_sprite_use helper in your view:

# app/views/dogs/show.html.erb
<%= svg_sprite_use "dogs/chihuahua" %>

And Savagery will do all the hard work of spriting and embedding. A new .svg sprite file will appear in the app/assets/svgs directory, named after the directory containing the sprites:

app/assets/svgs/
├── dogs
│   ├── chihuahua.svg
│   ├── golden.svg
│   └── lab.svg
└── dogs.svg

Make sure you check this file into version control.

Contributing

  1. Fork it ( https://github.com/botandrose/savagery/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request