markdown-it-toc-right v1.0.1

markdown-it-toc-right

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

Usage

Enable plugin

let md = require('markdown-it')({
  html: true,
  linkify: true,
  typography: true
}).use(require('markdown-it-toc-right')); // <-- this use(package_name) is required

Example

@[toc](Title)

Adding this tag with add anchors to each <h[n]> tag on your document, and will add a <ul> of hyperlinks pointing to these places on the page.

The end results looks like:

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

Css

.toc-box {
     position: absolute;
     top: 0px;
     right: 30px;
     width: 250px;
}