grunt-assemble-navigation
v0.1.0
Published
Assemble navigation plugin. Automatically generate Bootstrap-style, multi-level side nav. See the sidenav on assemble.io for a demonstration.
Downloads
3
Readme
grunt-assemble-navigation
Assemble navigation plugin. Automatically generate Bootstrap-style, multi-level side nav. See the sidenav on assemble.io for a demonstration.
Here's a preview
Quickstart
Install with npm
$ npm i grunt-assemble-navigation --save
Usage
Register the middleware with Assemble:
options: {
plugins: ['grunt-assemble-navigation', 'foo/*.js']
}
Visit the plugins docs for more info or for help getting started.
Add this markup where you want the navigation:
<div id="navigation">
<!-- navigation -->
</div>
The plugin uses page headings to construct the nav items, results in something like:
<div id="navigation">
<!-- navigation -->
<ul class="nav sidenav">
<li><a href="#collections">Collections</a>
<ul class="nav">
<li> <a href="#collections-after">{{after}}</a> </li>
<li> <a href="#collections-any">{{any}}</a> </li>
<li> <a href="#collections-before">{{before}}</a> </li>
</ul>
</li>
</ul>
</div>
Other grunt-assemble middleware
- 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-i18n: Plugin for adding i18n support to Assemble projects. | 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
- grunt-assemble-toc: Assemble middleware for adding a Table of Contents (TOC) to any HTML page. | homepage
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Authors
Jon Schlinkert
License
Copyright © 2015 Jon Schlinkert Released under the MIT license.
This file was generated by verb-cli on September 24, 2015.