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
• Configurations
• Contributors
• Questions?
• License

Usage

The PopupWindow in following gif is Command Shift P.

Installation

rm ~/.atom/packages
cd ~/.atom/packages
git clone https://github.com/zuzu59/markdown-toc.git

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
• Auto indent when Title not start from #
• Optional TOC title ## Table of Contents with title:[0,1]
• Soft/Hard tab support with tabSpaces:4. 0 for hard others for soft. Default is @Editor.tabLength.
• Option to skip 0 to n titles with skip:[0|n]
• Works with French accented letters

Configurations

To change the configurations,Change the value in text：

<!-- TOC titleSize:2 tabSpaces:2 depthFrom:1 depthTo:6 withLinks:1 updateOnSave:1 orderedList:0 skip:1 title:1 -->

and then Update the TOC.

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
• jokinkuang
• ponsfrilus
• zuzu59

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.