grunt-markdown-toc

Generate a markdown TOC (table of contents) with Remarkable.

Table of Contents

• Getting Started
• The "markdown-toc" task
  • Overview
• Contributing
• Core lib
• Release History

Getting Started

This plugin requires Grunt ~1.0.1

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-markdown-toc --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('markdown_toc');

The "markdown-toc" task

Overview

In your project's Gruntfile, add a section named markdown-toc to the data object passed into grunt.initConfig().

grunt.initConfig({
  markdown_toc: {
      src: ['./README.md']
  }
});

Just add <!-- toc --> and <!-- tocstop --> to your markdown file.

## Table of Contents

<!-- toc -->

<!-- tocstop -->

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Core lib

markdown-toc

Release History

0.0.2 Init