phoihos/vscode-markdown-auto-gen-toc

Markdown Auto-generate TOC Extension for VS Code https://marketplace.visualstudio.com/items?itemName=phoihos.markdown-auto-gen-toc

Markdown AutoTOC

Auto-generate the table of contents to VS Code's built-in markdown preview.

Features

• Auto-generates the table of contents
• Supports to customize heading levels
  • See below Settings
• Supports to customize title header
  • See below Settings
• Supports Azure DevOps Wiki style table of contents token
  • See below Settings
• Supports to slugify exactly the same as VS Code's markdown for the anchor of the table of contents

Installation

To install this extension go to View->Extensions and search for markdown-auto-gen-toc. Next click Install.

Usage

Type [[TOC]] syntax where ever you want to insert the table of contents.

Settings

Table of contributed settings (prefix "markdownAutoTOC."):

Name	Default	Description
includeLevel	[2, 3]	Heading levels to include in the generated table of contents
containerClass	"table-of-contents"	The HTML class to apply to the container <div/> for the table of contents
containerHeaderHtml	"Contents"	Optional HTML string to display above the table of contents
markerPattern	"TOC"	Regex pattern of the token to generate the table of contents (Use "(TOC|_TOC_)" for Azure DevOps Wiki style)

Important: Any changes made don't take effect until the VS Code window is reloaded or restarted, because the configuration settings could applied when the extension is activated.

Issues

If you find any problems using this extension or you want to propose new features to it, feel free to open an issue on Github.

Release Notes

Detailed Release Notes are available here or above Changelog tab.

Attributions

Icon made by Freepik from www.flaticon.com