https://github.com/euskadi31/grunt-graphviz
Compile DOT files
https://github.com/euskadi31/grunt-graphviz
Last synced: about 2 months ago
JSON representation
Compile DOT files
- Host: GitHub
- URL: https://github.com/euskadi31/grunt-graphviz
- Owner: euskadi31
- License: mit
- Created: 2013-06-24T03:27:43.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2016-09-20T00:54:15.000Z (over 8 years ago)
- Last Synced: 2025-03-23T22:01:33.216Z (2 months ago)
- Language: JavaScript
- Size: 5.86 KB
- Stars: 3
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT
Awesome Lists containing this project
README
# grunt-graphviz
> Compile DOT files
## Dependencies
* Graphviz
### Install
Linux Gentoo
```shell
emerge -av media-gfx/graphviz
```
## Getting Started
This plugin requires Grunt `>=0.4.0`
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 install grunt-graphviz --save-dev
```
OSX
```shell
brew install graphviz
```
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
```js
grunt.loadNpmTasks('grunt-graphviz');
```
## The "graphviz" task
### Overview
In your project's Gruntfile, add a section named `graphviz` to the data object passed into `grunt.initConfig()`.
```js
grunt.initConfig({
graphviz: {
your_target: {
files: {
'dest/file.png': 'source/file.dot',
// etc...
}
},
},
})
```
## 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/).