Locates all Level 2 headings in the currently selected markdown file and creates a clean, orderly table of contents near the top that links to all Level 2 heading labels for simplified navigation.
- Creates a Table of Contents in the currently open markdown file.
- Links to Level 2 heading IDs are stored in Table of contents.
- Uses the VSCode Command Palette to insert the new table of contents.
- Supports
#
character Headings ('Open ATX') markdown.
Open a Markdown File with Headings in it.
Open Command Palette to find "Create Table of Contents".
Select the command and a Table of Contents will be created with Heading IDs linked up.
The only dependencies are `vscode ^1.79.0 and those listed in devDependencies in the package.json file in my GitHub Project Repo.
Contributes.Command: markdown-toc.createTOC
"Create Table of Contents"
ActivationEvents: none.
- No support for 'next-line' heading markdown that uses
=
or-
as Heading level indicators. - No support for 'closed atx' style headings.
Note: See GitHub Issues List for the most current status.
- Bugfix and feature update.
See CHANGELOG.md for detailed release notes.
Design, code, test, and publisher: Jon Rumsey GitHub LinkedIn
- Markdown Rules guidance from DavidAnson's Markdown Lint repo
- GitIgnore suggestions from TopTal.com
- Guidance on how to create a VS Code Extension from VS Code Docs