chalkpe / markdown-toc

Generate TOC of headlines from parsed markdown file.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Markdown TOC

Generate TOC (table of contents) of headlines from parsed markdown file.

Usage example

Installation

apm install markdown-toc

Features

  • Auto linking via anchor tags, e.g. # A 1#a-1
  • Depth control [1-6] with depthFrom:1 and depthTo:6
  • Enable or disable links with withLinks:1
  • Refresh list on save with updateOnSave:1
  • Use ordered list (1. ..., 2. ...) with orderedList:0

Contributors

Questions?

Don't be shy and feel free to contact me via Twitter.

License

The package is Open Source Software released under the License. It's developed by Darius Morawiec.

About

Generate TOC of headlines from parsed markdown file.

License:MIT License


Languages

Language:CoffeeScript 100.0%