assemble-contrib-anchors

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

assemble-contrib-anchors

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

<h1 id="glyphicons">Glyphicons</h1>
<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

Visit the anchors example repo.

In the command line, run:

npm install assemble-contrib-anchors --save

Next, register the plugin with Assemble:

var options = {
  plugins: ['assemble-contrib-anchors', 'other/plugins/*']
};

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: ['assemble-contrib-anchors'],
  anchors: {
    template: './path/to/custom/template.js'
  }
}

Visit the plugins docs for more info or for help getting started.

Here are some related projects you might be interested in from the Assemble core team.

Visit assemble.io/plugins for more information about Assemble plugins.

Find a bug? Have a feature request? Please create an Issue.

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality, and run docs in the command line to build the docs with Verb.

Pull requests are also encouraged, and if you find this project useful please consider "starring" it to show your support! Thanks!

Brian Woodward

Copyright (c) 2014 Brian Woodward, contributors.
Released under the MIT license


This file was generated by verb-cli on May 01, 2014.