https://github.com/darosh/node-svink
SVG Inkscape multi-rasterizer.
https://github.com/darosh/node-svink
Last synced: about 1 month ago
JSON representation
SVG Inkscape multi-rasterizer.
- Host: GitHub
- URL: https://github.com/darosh/node-svink
- Owner: darosh
- License: mit
- Created: 2014-01-04T19:38:18.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2015-09-07T13:44:09.000Z (over 9 years ago)
- Last Synced: 2025-04-11T11:35:04.017Z (about 1 month ago)
- Language: JavaScript
- Homepage:
- Size: 247 KB
- Stars: 2
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT
Awesome Lists containing this project
README
# node-svink 
[](http://travis-ci.org/darosh/node-svink) [](https://coveralls.io/r/darosh/node-svink) [](https://gemnasium.com/darosh/node-svink) [](http://badge.fury.io/js/svink) [](http://gruntjs.com/)
SVG Inkscape multi-rasterizer.
## Getting Started
### Prerequisites
[Inkscape](http://www.inkscape.org/) installed.
### Install
- For commandline usage: `npm install -g svink`
- For API: `npm install svink`
## Commandline Usage
```
Usage:
svink [options]
Options:
-i, --input input SVG file [default: "graphics.svg"]
-o, --output output PNG file [default: "graphics.png"]
-p, --output-path output path [default: "build"]
-c, --config config file [default: "graphics.json"]
-s, --id select id
-f, --filter filter regex
-a, --all select all
-W, --width render width in pixels
-H, --height render height in pixels
-S, --size render rectangle in pixels
-D, --dpi export dpi
-C, --scale export scale
-B, --background export background color
-l, --log path to log
-n, --no-render disable render
-?, --help show help
--probe probe Inkscape version
-d, --debug show debug messages
Placeholders (in output file name):
index: number of rendered file
file: input file name
id: SVG element id
Examples:
svink -i graphics.svg -o rasterized.png
svink -d -a -S 48 -i *.svg -o {index}-{file}-{id}.png
```
## API Usage
```javascript
var opt = {
input: 'graphics.svg',
output: 'graphics.png',
'output-path': 'build', // output directory
config: 'path/to/file.json' // json or yaml
id: 'asset_id_3', // element string id
filter: 'rect.*', // regex based id filter
all: false, // all elements in SVG input file
width: 48,
height: 48,
size: 48, // size sets width and height
dpi: 90, // 90 is Inkscape default
scale: 1.0, // alternative to dpi
background: '#ff00ff',
};
function callback(err, log) {
}
var svink = require('svg-inkscape-rasterizer').svink;
// with callback
svink(options, callback);
// or without callback
svink(options);
```
## Examples
More examples: [test/commands](https://github.com/darosh/node-svink/tree/master/test/commands) and [test/commands-query](https://github.com/darosh/node-svink/tree/master/test/commands-query).
## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).
## License
Copyright (c) 2014 Jan Forst
Licensed under the MIT license.
[](https://bitdeli.com/free "Bitdeli Badge")