https://github.com/shinnn/grunt-flex-svg

Grunt task for creating SVG files of flexible width and height
https://github.com/shinnn/grunt-flex-svg

Last synced: 27 days ago
JSON representation

Grunt task for creating SVG files of flexible width and height

• Host: GitHub
• URL: https://github.com/shinnn/grunt-flex-svg
• Owner: shinnn
• License: mit
• Created: 2014-01-31T16:56:28.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2014-08-19T14:37:01.000Z (about 10 years ago)
• Last Synced: 2024-10-04T17:10:02.205Z (about 1 month ago)
• Language: JavaScript
• Homepage:
• Size: 383 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# grunt-flex-svg

[![NPM version](https://badge.fury.io/js/grunt-flex-svg.svg)](http://badge.fury.io/js/grunt-flex-svg)

[![Build Status](https://travis-ci.org/shinnn/grunt-flex-svg.svg?branch=master)](https://travis-ci.org/shinnn/grunt-flex-svg)

[![Dependency Status](https://david-dm.org/shinnn/grunt-flex-svg.svg)](https://david-dm.org/shinnn/grunt-flex-svg)

[![devDependency Status](https://david-dm.org/shinnn/grunt-flex-svg/dev-status.svg)](https://david-dm.org/shinnn/grunt-flex-svg#info=devDependencies)

Grunt task for creating SVG files with flexible width and height using [flex-svg](https://github.com/shinnn/node-flex-svg)

## Getting Started

This plugin requires Grunt.

If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

```shell

npm i --save-dev grunt-flex-svg

```

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

```javascript

grunt.loadNpmTasks('grunt-flex-svg');

```

## The `flex_svg` task

### Overview

In your project's Gruntfile, add a section named `flex_svg` to the data object passed into `grunt.initConfig()`.

```javascript

grunt.initConfig({

  flex_svg: {

    your_target: {

      src: ['path/to/src/fixed.svg']

      dest: 'path/to/dest/flexible.svg'

    }

  }

})

```

## 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 [Shinnosuke Watanabe](https://github.com/shinnn).

Licensed under [the MIT license](./LICENSE).