Markdown TOC

Generate and update magically a table of contents based on the headlines of a parsed markdown file.

Table of Contents

• Usage
• Installation
• Features
• Contributors
• Questions?
• License

Usage

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

Thanks to all contributors for any fix or improvement, whether small or large.

• Giacomo Bresciani
• Kévin Lanceplaine
• Ilya Zelenin
• spjoe
• Tom Byrer
• betrue12

Questions?

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

License

The package is Open Source Software released under the MIT license.