https://github.com/assemble/grunt-assemble-toc
Assemble middleware for creating a table of contents in the generated HTML, using Cheerio.js
https://github.com/assemble/grunt-assemble-toc
Last synced: 7 months ago
JSON representation
Assemble middleware for creating a table of contents in the generated HTML, using Cheerio.js
- Host: GitHub
- URL: https://github.com/assemble/grunt-assemble-toc
- Owner: assemble
- License: mit
- Created: 2013-11-11T03:11:58.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2015-09-25T13:20:33.000Z (over 10 years ago)
- Last Synced: 2025-02-10T10:47:31.563Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 151 KB
- Stars: 5
- Watchers: 12
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# grunt-assemble-toc [](http://badge.fury.io/js/grunt-assemble-toc)
> Assemble middleware for adding a Table of Contents (TOC) to any HTML page.
## Quickstart
In the command line, run:
```sh
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:
```js
assemble: {
options: {
plugins: ['grunt-assemble-toc', 'other/plugins/*.js']
}
}
```
Visit the [plugins docs](http://assemble.io/plugins/) 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
```js
assemble: {
options: {
plugins: ['grunt-assemble-toc'],
toc: {
id: 'toc',
modifier: ''
}
}
}
```
## Assemble plugins
* [grunt-assemble](https://www.npmjs.com/package/grunt-assemble): Static site generator for Grunt.js, Yeoman and Node.js. Used by Zurb Foundation, Zurb Ink, H5BP/Effeckt,… [more](https://www.npmjs.com/package/grunt-assemble) | [homepage](http://assemble.io)
* [grunt-assemble-anchors](https://www.npmjs.com/package/grunt-assemble-anchors): Assemble plugin for creating anchor tags from headings in generated html using Cheerio.js. | [homepage](https://github.com/assemble/grunt-assemble-anchors)
* [grunt-assemble-contextual](https://www.npmjs.com/package/grunt-assemble-contextual): Generates a JSON file with the context of each page. Basic plugin to help see… [more](https://www.npmjs.com/package/grunt-assemble-contextual) | [homepage](https://github.com/assemble/grunt-assemble-contextual)
* [grunt-assemble-decompress](https://www.npmjs.com/package/grunt-assemble-decompress): Assemble plugin for extracting zip, tar and tar.gz archives. | [homepage](https://github.com/assemble/grunt-assemble-decompress)
* [grunt-assemble-download](https://www.npmjs.com/package/grunt-assemble-download): Assemble plugin for downloading files from GitHub. | [homepage](https://github.com/assemble/grunt-assemble-download)
* [grunt-assemble-i18n](https://www.npmjs.com/package/grunt-assemble-i18n): Plugin for adding i18n support to Assemble projects. | [homepage](https://github.com/assemble/grunt-assemble-i18n)
* [grunt-assemble-lunr](https://www.npmjs.com/package/grunt-assemble-lunr): Assemble plugin for adding search capabilities to your static site, with lunr.js. | [homepage](http://assemble.io)
* [grunt-assemble-navigation](https://www.npmjs.com/package/grunt-assemble-navigation): Assemble navigation plugin. Automatically generate Bootstrap-style, multi-level side nav. See the sidenav on assemble.io for… [more](https://www.npmjs.com/package/grunt-assemble-navigation) | [homepage](https://github.com/assemble/grunt-assemble-navigation)
* [grunt-assemble-permalinks](https://www.npmjs.com/package/grunt-assemble-permalinks): Permalinks plugin for Assemble, the static site generator for Grunt.js, Yeoman and Node.js. This plugin… [more](https://www.npmjs.com/package/grunt-assemble-permalinks) | [homepage](https://github.com/assemble/grunt-assemble-permalinks)
* [grunt-assemble-sitemap](https://www.npmjs.com/package/grunt-assemble-sitemap): Sitemap plugin for Assemble | [homepage](http://assemble.io/plugins)
* [grunt-assemble-wordcount](https://www.npmjs.com/package/grunt-assemble-wordcount): Assemble plugin for displaying wordcount and average reading time to blog posts or pages. | [homepage](https://github.com/assemble/grunt-assemble-wordcount)
## Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/assemble/grunt-assemble-toc/issues/new).
## Author
**Brian Woodward**
+ [github/assemble](https://github.com/assemble)
+ [twitter/assemble](http://twitter.com/assemble)
## License
Copyright © 2015 Brian Woodward
Released under the MIT license.
***
_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on September 25, 2015._