UNPKG

grunt-toc

Version:

Grunt plugin for generating a markdown Table of Contents (TOC).

44 lines (26 loc) 1.4 kB
# grunt-toc [![NPM version](https://badge.fury.io/js/grunt-toc.png)](http://badge.fury.io/js/grunt-toc) > Grunt plugin for generating a markdown Table of Contents (TOC). ## Getting Started This plugin requires Grunt `~0.4.1` If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command: ```shell npm install grunt-toc --save-dev ``` One the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript: ```js grunt.loadNpmTasks('grunt-toc'); ``` ## Contributing Please see the [Contributing to Assemble](http://assemble.io/contributing) guide for information on contributing to this project. ## Authors **Jon Schlinkert** + [twitter.com/jonschlinkert](http://twitter.com/jonschlinkert) + [github.com/jonschlinkert](http://github.com/jonschlinkert) **Brian Woodward** + [twitter.com/doowb](http://twitter.com/doowb) + [github.com/doowb](http://github.com/doowb) ## License Copyright (c) 2013 Sellside Inc. Released under the [MIT License](./LICENSE-MIT). *** _This file was generated on Friday, November 8, 2013._