Markdown TOC

1. Summary

• 1. Summary
• 2. Features
• 3. Usage
• 4. Configuration
• 5. Example
• 6. About
• 7. Roadmap

A Visual Studio Code extension that generates a table of contents for your markdown file.

2. Features

• Generate a Table of Content base on markdown title (from level 2 to 4).
• Replace an existing toc when generate it again
• Insert anchor on your titles
• Auto-saving when a toc is generated
• Configurable generation of
  • Numbering your table of contents
  • Save your document when table of content generated

3. Usage

• Open any markdown file
• Open the command palette (Ctrl+Shift+P)
• Type "Generate"
• Choose "Generate TOC for markdown"

4. Configuration

5. Example

<!-- vscode-markdown-toc -->
* 1. [Summary](#Summary)
* 2. [Features](#Features)
* 3. [Usage](#Usage)
* 4. [Configuration](#Configuration)
* 5. [Example](#Example)
* 6. [About](#About)
* 7. [Roadmap](#Roadmap)

<!-- vscode-markdown-toc-config
	numbering=true
	autoSave=true
	/vscode-markdown-toc-config -->
<!-- /vscode-markdown-toc -->

##  1. <a name='Summary'></a>Summary 
##  2. <a name='Features'></a>Features 
##  3. <a name='Usage'></a>Usage
##  4. <a name='Configuration'></a>Configuration 
##  5. <a name='Example'></a>Example 
##  6. <a name='About'></a>About
##  7. <a name='Roadmap'></a>Roadmap

6. About

This plugin is based on the work of Kiran Rao, I've updated it to my needs and push my work on GitHub and published it in the marketplace.

7. Roadmap

• Add a configuration to
  • enable/disable numbering
  • increase/decrease title's level managed
• Unit testing

Fell free to submit issues or merge requests !