svg-spritify
Version:
SVG sprite generator CLI tool
56 lines (36 loc) • 1.83 kB
Markdown
# svg-spritify [](https://www.npmjs.com/package/svg-spritify) [](https://npmjs.org/package/svg-spritify) [](https://npmjs.org/package/svg-spritify)
> Creating SVG sprites has never been this easy. Easily generate sprites out of your SVG files.
SVG sprite generator CLI tool
Please consider following this project's author, [Sina Bayandorian](https://github.com/sina-byn), and consider starring the project to show your :heart: and support.
### Note:
If you want granular control over the sprite generation process with a fully configurable setup, use version [**`svg-spritify@1.2.2`**](https://www.npmjs.com/package/svg-spritify/v/1.2.2).
Versions starting from **`2.0.0`** are designed to be **highly customizable via CSS**, rather than relying on extensive configuration.
## Install
Install with [npm](https://www.npmjs.com/package/svg-spritify) :
```sh
npm install -g svg-spritify
```
## Usage
```sh
npx sprite
```
```html
<svg width="20" height="20">
<use href="/path/to/icons.svg#id" />
</svg>
<!-- change icon's size and color -->
<svg width="40" height="40" style="color: blue">
<use href="/path/to/icons.svg#id" />
</svg>
```
## Options
### `--no-recursive`
By default, this package searches for SVG files in all subdirectories. Use the `--no-recursive` option to limit the search to the specified directory only.
```sh
npx sprite --no-recursive
```
### `-i, --input <directory>`
Specifies the directory where the SVG files are located. Defaults to `process.cwd()`.
```sh
npx sprite -i /path/to/svgs
```