Skip to content

An extension for VS Code that adds support for an auto-generated table of contents to the built-in markdown preview

License

Notifications You must be signed in to change notification settings

wibblemonkey/vscode-markdown-auto-toc

Repository files navigation

Adds support for inserting an auto-generated table of contents into the built-in markdown preview using the [[TOC]] syntax.

Markdown AutoTOC

Features

The rendered table of contents includes the top two levels of headings by default (i.e. headings prefixed by # and ##) but you can include up to 6 levels of headings if you choose. You can also include an optional title header for the table of contents itself and override the default HTML class applied to the <div/> container elements for both the table of contents and the title header.

The extension also supports the Azure DevOps Wiki style table of contents token [[_TOC_]]. This is enabled by default but can be turned off if desired.

Extension Settings

This extension contributes the following settings:

Name Default Value Description
markdownAutoTOC.maximumHeadingLevel 2 The maximum heading level to include in the generated table of contents
markdownAutoTOC.containerClass toc-container The HTML class to apply to the generated <div/> for the table of contents.
markdownAutoTOC.header true Include a heading above the generated table of contents.
markdownAutoTOC.headerClass toc-container-header The HTML class to apply to the generated <div/> for the table of contents header.
markdownAutoTOC.headerContent Contents The header text to display above the table of contents.
markdownAutoTOC.enableAzureDevOpsWikiCompatibility true Allow [[_TOC_]] as the token to generate the table of contents.

Known Issues

  • The configuration settings are loaded when the extension is activated, so any changes made don't take effect until the VS Code window is reloaded or restarted.

About

An extension for VS Code that adds support for an auto-generated table of contents to the built-in markdown preview

Resources

License

Stars

Watchers

Forks

Packages

No packages published