Assemble plugin for creating anchor tags from generated html.
HTML JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
example
lib
test
.bowerrc
.gitattributes
.gitignore
.jshintrc
.verbrc.md
Gruntfile.js
LICENSE-MIT
README.md
index.js
package.json

README.md

grunt-assemble-anchors NPM version

Assemble plugin for creating anchor tags from headings in generated html using Cheerio.js.

Example

Before

<h1 id="glyphicons">Glyphicons</h1>

After

<h1 class="docs-heading">
  <a href="#heading-id-name" name="heading-id-name" class="anchor">
    <span class="anchor-target" id="heading-id-name"></span>
    <span class="glyphicon glyphicon-link"></span>
  </a>
  Glyphicons
</h1>

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

image

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:

module.exports = [
  '<a href="#<%= id %>" name="<%= id %>" class="anchor">',
  '  <span class="anchor-target" id="<%= id %>"></span>',
  '  <span class="glyphicon glyphicon-link"></span>',
  '</a>'
].join('\n');

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.