{"id":18434688,"url":"https://github.com/assemble/grunt-assemble-navigation","last_synced_at":"2025-04-07T19:31:54.432Z","repository":{"id":15402348,"uuid":"18134314","full_name":"assemble/grunt-assemble-navigation","owner":"assemble","description":"Assemble plugin for automatically generating Bootstrap-style side navigation. ","archived":false,"fork":false,"pushed_at":"2015-09-25T13:21:46.000Z","size":147,"stargazers_count":10,"open_issues_count":2,"forks_count":4,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-03-26T20:01:38.093Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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":"2014-03-26T10:23:25.000Z","updated_at":"2017-06-03T20:28:15.000Z","dependencies_parsed_at":"2022-08-26T07:41:11.042Z","dependency_job_id":null,"html_url":"https://github.com/assemble/grunt-assemble-navigation","commit_stats":null,"previous_names":["assemble/assemble-contrib-navigation"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/assemble%2Fgrunt-assemble-navigation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/assemble%2Fgrunt-assemble-navigation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/assemble%2Fgrunt-assemble-navigation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/assemble%2Fgrunt-assemble-navigation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/assemble","download_url":"https://codeload.github.com/assemble/grunt-assemble-navigation/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246892820,"owners_count":20850847,"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-11-06T06:04:55.024Z","updated_at":"2025-04-07T19:31:54.154Z","avatar_url":"https://github.com/assemble.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# grunt-assemble-navigation [![NPM version](https://badge.fury.io/js/grunt-assemble-navigation.svg)](http://badge.fury.io/js/grunt-assemble-navigation)\n\n\u003e Assemble navigation plugin. Automatically generate Bootstrap-style, multi-level side nav. See the sidenav on assemble.io for a demonstration.\n\n**Here's a preview**\n\n![image](https://f.cloud.github.com/assets/383994/2523672/94f62414-b4d4-11e3-98c6-fc3c07bef4b4.png)\n\n***\n\n## Quickstart\n\nInstall with [npm](https://www.npmjs.com/)\n\n```sh\n$ npm i grunt-assemble-navigation --save\n```\n\n## Usage\n\nRegister the middleware with Assemble:\n\n```js\noptions: {\n  plugins: ['grunt-assemble-navigation', 'foo/*.js']\n}\n```\n\nVisit the [plugins docs](http://assemble.io/plugins/) for more info or for help getting started.\n\nAdd this markup where you want the navigation:\n\n```html\n\u003cdiv id=\"navigation\"\u003e\n  \u003c!-- navigation --\u003e\n\u003c/div\u003e\n```\n\nThe plugin uses page headings to construct the nav items, results in something like:\n\n```html\n\u003cdiv id=\"navigation\"\u003e\n  \u003c!-- navigation --\u003e\n  \u003cul class=\"nav sidenav\"\u003e\n    \u003cli\u003e\u003ca href=\"#collections\"\u003eCollections\u003c/a\u003e\n      \u003cul class=\"nav\"\u003e\n        \u003cli\u003e \u003ca href=\"#collections-after\"\u003e{{after}}\u003c/a\u003e \u003c/li\u003e\n        \u003cli\u003e \u003ca href=\"#collections-any\"\u003e{{any}}\u003c/a\u003e \u003c/li\u003e\n        \u003cli\u003e \u003ca href=\"#collections-before\"\u003e{{before}}\u003c/a\u003e \u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n  \u003c/ul\u003e\n\u003c/div\u003e\n```\n\n***\n\n## Other grunt-assemble middleware\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-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-toc](https://www.npmjs.com/package/grunt-assemble-toc): Assemble middleware for adding a Table of Contents (TOC) to any HTML page. | [homepage](http://assemble.io)\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-navigation/issues/new).\n\n## Authors\n\n**Jon Schlinkert**\n\n+ [github/jonschlinkert](https://github.com/jonschlinkert)\n+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)\n\n## License\n\nCopyright © 2015 Jon Schlinkert\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-navigation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fassemble%2Fgrunt-assemble-navigation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fassemble%2Fgrunt-assemble-navigation/lists"}