grunt-assemble-anchors
Assemble plugin for creating anchor tags from headings in generated html using Cheerio.js.
Example
Before
Glyphicons
After
Glyphicons
Currently the plugin adds Bootstrap glyphicon classes. If you want to use different classes, find a bug, or have a feature request, please create an issue
Visit the anchors example repo.
Quickstart
In the command line, run:
npm install grunt-assemble-anchors --save
Next, register the plugin with Assemble:
assemble: options = plugins: 'grunt-assemble-anchors' 'other/plugins/*' ;
Options
template
Specify a custom template (Underscore/Lo-Dash) to use for anchor markup. This is the default template:
moduleexports = '<a href="#<%= id %>" name="<%= id %>" class="anchor">' ' <span class="anchor-target" id="<%= id %>"></span>' ' <span class="glyphicon glyphicon-link"></span>' '</a>';
To use a custom template just specify it in the options as follows:
options: plugins: 'grunt-assemble-anchors' anchors: template: './path/to/custom/template.js'
Visit the plugins docs for more info or for help getting started.
Other grunt-assemble plugins
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Author
Brian Woodward
License
Copyright © 2015 Brian Woodward Released under the MIT license.
This file was generated by verb-cli on September 24, 2015.