1.0.0 • Published 7 years ago

toccer v1.0.0

Weekly downloads
1
License
ISC
Repository
-
Last release
7 years ago

toccer

Tool for adding table of contents to markdown files.

Installation

To install toccer as a CLI tool: npm install -g toccer

Usage

Place link token somewhere in your markdown

[](toc)

Add some level two headers:

## This is a header

content

## more header

more content

Then, run the command: toccer path-to-markdown.md

This will create a TOC in path-to-markdown.md!

Note: Level one headers will not be included in the TOC.

Limit Level

Use the option max-level to limit how deep the TOC goes.

[](toc&max-level=3)

This will only use up to level 3 headers in the TOC.