CenterForOpenScience/markdown-it-toc

Name: markdown-it-toc

Owner: Center for Open Science

Description: null

Created: 2015-02-12 18:17:02.0

Updated: 2018-05-07 08:15:42.0

Pushed: 2016-09-22 18:43:24.0

Homepage: null

Size: 270

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

markdown-it-toc

markdown-it plugin for adding a table of contents to markdown documents

Usage

Enable plugin

md = require('markdown-it')({
ml: true,
nkify: true,
pography: true
se(require('markdown-it-toc')); // <-- this use(package_name) is required

Example

c](Title)

Adding this tag with add anchors to each `<h[n]>tag on your document, and will add a ``

``` of hyperlinks pointing to these places on the page.

The end results looks like:

 <h3>Title</h3>
 <ul>
<li><a href="...">Heading 1</a></li>
...
... 
 </ul> 



<a href="..."></a>Heading 1</h1>

Testing

To run the tests use:

 test