grunt-iconic-doc
Extract yaml documentation from an iconic svg and convert it to json
Getting Started
This plugin requires Grunt ~0.4.
If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
npm install grunt-iconic-doc --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt;
Writing your docs in YAML
This plugin expects your documentation to be written in YAML and stored in a script
tag. Take a look at the test/fixtures
directory for more examples.
Example
Configuration
To configure the task just pass in a src
directory, with subfolders for each icon and a dest
directory. If you omit the dest
directory, then the json will be generated in the same folder as the src
.
iconicdoc:files:src: 'icons'dest: 'icons-out'
Options
selector
Default: .iconic-documentation
Type: String
The task will attempt to extract its documentation from an element that matches this selector.
svgmerge: files: src: 'icons' dest: 'icons-out' options: selector: '#foo-docs'
outputFile
Default: api.json
Type: String
The filename that will be used when the documentation is output.
svgmerge: files: src: 'icons' dest: 'icons-out' options: outputFile: 'my-docs.json'
License
Copyright (c) 2014 Rob Dodson. Licensed under the MIT license.