assemble / assemble-contrib-anchors-example

Usage examples for assemble-contrib-anchors, an Assemble plugin for generating adding anchors to headings.

Home Page:http://assemble.github.io/assemble-contrib-anchors-example/components.html

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

example-assemble-anchors NPM version

Usage examples for assemble-contrib-anchors, an Assemble plugin for generating a HTML Table of Contents

Before

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

After

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

Currently the plugin adds Bootstrap glyphicon classes. If you want to use different classes, find a bug, or have a feature request, plesae create an issue

Example

image

Quick start

The following quick start options are available:

  • Install with Bower: bower install example-assemble-anchors.
  • Clone the repo: git clone https://github.com/assemble/example-assemble-anchors.git.
  • Download the latest release.

Contributing

Please read through the contributing guidelines. 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.

Editor preferences are available in the editor config for easy use in common text editors. Read more and download plugins at http://editorconfig.org.

Release History

  • 2013   v0.1.0   First commit

License

Copyright (c) 2013 Brian Woodward Licensed under the MIT license.


Project created by Brian Woodward.

This file was generated on Sun Nov 10 2013 22:27:53.

About

Usage examples for assemble-contrib-anchors, an Assemble plugin for generating adding anchors to headings.

http://assemble.github.io/assemble-contrib-anchors-example/components.html

License:MIT License


Languages

Language:JavaScript 91.1%Language:CSS 8.9%