{"id":15046269,"url":"https://github.com/assemble/grunt-assemble-toc","last_synced_at":"2025-10-26T14:31:37.331Z","repository":{"id":11757519,"uuid":"14290300","full_name":"assemble/grunt-assemble-toc","owner":"assemble","description":"Assemble middleware for creating a table of contents in the generated HTML, using Cheerio.js","archived":false,"fork":false,"pushed_at":"2015-09-25T13:20:33.000Z","size":155,"stargazers_count":5,"open_issues_count":1,"forks_count":4,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-02-10T10:47:31.563Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/assemble.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-11-11T03:11:58.000Z","updated_at":"2015-09-25T03:11:39.000Z","dependencies_parsed_at":"2022-09-09T08:51:45.059Z","dependency_job_id":null,"html_url":"https://github.com/assemble/grunt-assemble-toc","commit_stats":null,"previous_names":["assemble/assemble-contrib-toc","assemble/assemble-middleware-toc","assemble/assemble-toc"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/assemble%2Fgrunt-assemble-toc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/assemble%2Fgrunt-assemble-toc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/assemble%2Fgrunt-assemble-toc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/assemble%2Fgrunt-assemble-toc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/assemble","download_url":"https://codeload.github.com/assemble/grunt-assemble-toc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238347845,"owners_count":19457002,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-09-24T20:52:56.130Z","updated_at":"2025-10-26T14:31:36.972Z","avatar_url":"https://github.com/assemble.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# grunt-assemble-toc [![NPM version](https://badge.fury.io/js/grunt-assemble-toc.svg)](http://badge.fury.io/js/grunt-assemble-toc)\n\n\u003e Assemble middleware for adding a Table of Contents (TOC) to any HTML page.\n\n## Quickstart\n\nIn the command line, run:\n\n```sh\nnpm install grunt-assemble-toc --save-dev\n```\n\nNext, 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:\n\n```js\nassemble: {\n  options: {\n    plugins: ['grunt-assemble-toc', 'other/plugins/*.js']\n  }\n}\n```\n\nVisit the [plugins docs](http://assemble.io/plugins/) for more info or for help getting started.\n\n## Options\n\n## toc\n\nType: `String`\nDefault: `'toc'`\n\nTag to determine where the table of contents is located\n\n## modifier\n\nType: `String`\nDefault: `''`\n\nCSS class used in the wrapper `ul` for the table of contents.\n\n## Usage Examples\n\n```js\nassemble: {\n  options: {\n    plugins: ['grunt-assemble-toc'],\n    toc: {\n      id: 'toc',\n      modifier: ''\n    }\n  }\n}\n```\n\n## Assemble plugins\n\n* [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)\n* [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)\n* [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)\n* [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)\n* [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)\n* [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)\n* [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)\n* [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)\n* [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)\n* [grunt-assemble-sitemap](https://www.npmjs.com/package/grunt-assemble-sitemap): Sitemap plugin for Assemble | [homepage](http://assemble.io/plugins)\n* [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)\n\n## Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/assemble/grunt-assemble-toc/issues/new).\n\n## Author\n\n**Brian Woodward**\n\n+ [github/assemble](https://github.com/assemble)\n+ [twitter/assemble](http://twitter.com/assemble)\n\n## License\n\nCopyright © 2015 Brian Woodward\nReleased under the MIT license.\n\n***\n\n_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on September 25, 2015._","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fassemble%2Fgrunt-assemble-toc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fassemble%2Fgrunt-assemble-toc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fassemble%2Fgrunt-assemble-toc/lists"}