assemble-middleware-toc

assemble-middleware-toc

Assemble middleware for adding a Table of Contents (TOC) to any HTML page.

Upgrade notice!: as of v0.2.0, this middlweare requires Assemble v0.5.0.

Install

Install with npm:

npm i assemble-middleware-toc --save

Usage

Register the middleware with Assemble:

options: {
  middleware: ['assemble-middleware-toc', 'foo/*.js']
}

Visit Assemble's middleware docs for more info or for help getting started.

Getting help

• Visit Assemble's middleware documentation, or general documentation
• Ask general questions or get help on StackOverflow. Please remember to use the assemble tag in your questions.
• Don't like Assemble? Here are some other static site generators you might find interesting.

Bugs and feature requests

Before creating an issue, please search to see if a related one already exists (oh, and you should know that every time an issue is created on the wrong repo, a programmer loses his beard. I'm so serious it's not even funny. His actual beard, gone. So please try not to do that.)

• For bugs and feature requests related to this project, please create an issue here
• For Assemble bugs and feature requests, please create an issue on the main assemble project

Contributing

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!

Author

Brian Woodward

• github/doowb
• twitter/doowb

License

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

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