GitPlanet

Cheap and reliable Node.js hosting starts at $3/month, and $1/month static HTML hosting

Created with love in Canada, visit hostnodejs.com today

Feel like to post an Ad? Learn Details
All Projects → nok → markdown-toc

nok / markdown-toc

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

Programming Languages

coffeescript
4710 projects

Markdown TOC

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

Table of Contents

Usage

Magic

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.

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.

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].