grunt-assemble-toc

grunt-assemble-toc

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

Quickstart

In the command line, run:

npm install grunt-assemble-toc --save-dev

Next, to register the plugin with Assemble in your project's Gruntfile you can either specify the direct path to the plugin(s) (e.g. ./path/to/plugins/*.js), or if installed via npm, make sure the plugin is in the devDependencies of your project.js package.json, and simply add the module's name to the plugins option:

assemble: {
  options: {
    plugins: ['grunt-assemble-toc', 'other/plugins/*.js']
  }
}

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

Options

toc

Type: String Default: 'toc'

Tag to determine where the table of contents is located

modifier

Type: String Default: ''

CSS class used in the wrapper ul for the table of contents.

Usage Examples

assemble: {
  options: {
    plugins: ['grunt-assemble-toc'],
    toc: {
      id: 'toc',
      modifier: ''
    }
  }
}

Assemble plugins

• grunt-assemble: Static site generator for Grunt.js, Yeoman and Node.js. Used by Zurb Foundation, Zurb Ink, H5BP/Effeckt,… more | homepage
• grunt-assemble-anchors: Assemble plugin for creating anchor tags from headings in generated html using Cheerio.js. | homepage
• grunt-assemble-contextual: Generates a JSON file with the context of each page. Basic plugin to help see… more | homepage
• grunt-assemble-decompress: Assemble plugin for extracting zip, tar and tar.gz archives. | homepage
• grunt-assemble-download: Assemble plugin for downloading files from GitHub. | homepage
• grunt-assemble-lunr: Assemble plugin for adding search capabilities to your static site, with lunr.js. | homepage
• grunt-assemble-permalinks: Permalinks plugin for Assemble, the static site generator for Grunt.js, Yeoman and Node.js. This plugin… more | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Author

Brian Woodward

• github/assemble
• twitter/assemble

License

Copyright © 2015 Brian Woodward Released under the MIT license.

This file was generated by verb-cli on September 24, 2015.