Markdown TOC & Chapter Number

Add commands for table of contents (TOC) and chapter numbering to markdown.

1. Features

• Add command to generate a table of contents (TOC)
• Add command to add chapter numbers
• Control each depth independently
• Insert anchor in TOC

1.1. Demo

This gif animation is from the previous version.
The menu names are different from the latest version.

2. Commands and Configurations

2.1. Commands

Title	Command	Keybinding	In the Editor Right Click Menu
TOC: Insert/Update (markdown-toc-num)	markdown-toc-num.insertToc		Yes (You can hide by configuration)
TOC: Remove (markdown-toc-num)	markdown-toc-num.removeToc		Yes (You can hide by configuration)
Chapter num.: Insert/Update (markdown-toc-num)	markdown-toc-num.insertChapterNumber		Yes (You can hide by configuration)
Chapter num.: Remove (markdown-toc-num)	markdown-toc-num.removeChapterNumber		Yes (You can hide by configuration)

2.2. Configurations

Configuration ID	Description	Type	Default
markdown-toc-num.tocDepthFrom	TOC depth control, from [1-6]	number	2
markdown-toc-num.tocDepthTo	TOC depth control, to [1-6]	number	3
markdown-toc-num.chapterDepthFrom	Chapter numbering depth control, from [1-6]	number	2
markdown-toc-num.chapterDepthTo	Chapter numbering depth control, to [1-6]	number	6
markdown-toc-num.anchorMode	Anchor style [vscode,gitlab, vscode, gitlab, github, azure, embed, none]	string	vscode
markdown-toc-num.showMenuInsertToc	Show command in context menu, TOC: Insert/Update	boolean	true
markdown-toc-num.showMenuRemoveToc	Show command in context menu, TOC: Remove	boolean	true
markdown-toc-num.showMenuInsertChapterNumber	Show command in context menu, Chapter num.: Insert/Update	boolean	true
markdown-toc-num.showMenuRemoveChapterNumber	Show command in context menu, Chapter num.: Remove	boolean	true

You can override them inline.

<!-- TOC tocDepth:2..3 chapterDepth:2..6 anchorMode:vscode,gitlab -->

<!-- TOC tocDepthFrom:2 tocDepthTo:3 chapterDepthFrom:1 chapterDepthTo:6 anchorMode:embed -->

<!-- TOC tocDepthFrom:1 tocDepthTo:6 anchorMode:github -->

3. Supplementary functions

3.1. Omit chapter in TOC

You can exclude a chapter in TOC by appending comment.

<!-- TOC tocDepth:2..3 chapterDepth:2..6 anchorMode:github -->

- [1. AAA](#user-content-1-aaa)
    - [1.2. AAA-2](#user-content-12-aaa-2)

<!-- /TOC -->

## 1. AAA

### 1.1. AAA-1 <!-- omit in toc -->

### 1.2. AAA-2

3.2. Omit chapter from numbering

You can exclude a chapter from numbering by appending comment.

## 1. AAA

### AAA-1 <!-- omit from numbering -->

This chapter is excluded from numbering.

### AAA-2 <!-- omit in toc --> <!-- omit from numbering -->

`omit in toc` comment and `omit from numbering` comment can be use together.

### 1.2. AAA-3

4. Anchor Styles

You can select anchor style from vscode,gitlab, vscode, gitlab, github, azure, embed, or none.

4.1. VSCode & GitLab style

This style is compatible with VSCode & GitLab.
With this style, anchors are started with #

# title

<!-- TOC tocDepth:2..3 chapterDepth:2..6 anchorMode:vscode,gitlab -->

- [1. AAA](#1-aaa)
    - [1.1. AAA-1](#11-aaa-1)
    - [1.2. AAA-2](#12-aaa-2)

<!-- /TOC -->

## 1. AAA

### 1.1. AAA-1

### 1.2. AAA-2

4.2. GitHub style

This style is compatible with GitHub.
With this style, anchors are started with #user-content-.

• With this sytle, the anchor links in TOC do NOT work in VSCode markdown preview.

# title

<!-- TOC tocDepth:2..3 chapterDepth:2..6 anchorMode:github -->

- [1. AAA](#user-content-1-aaa)
    - [1.1. AAA-1](#user-content-11-aaa-1)
    - [1.2. AAA-2](#user-content-12-aaa-2)

<!-- /TOC -->

## 1. AAA

### 1.1. AAA-1

### 1.2. AAA-2

4.3. Azure DevOps style

This style is compatible with Azure DevOps.
With this style, anchors are started with #user-content-.

• With this sytle, the anchor links in TOC do NOT work in VSCode markdown preview.

# title

<!-- TOC tocDepth:2..3 chapterDepth:2..6 anchorMode:azure -->

- [1. AAA](#user-content-1.-aaa)
    - [1.1. AAA-1](#user-content-1.1.-aaa-1)
    - [1.2. AAA-2](#user-content-1.2.-aaa-2)

<!-- /TOC -->

## 1. AAA

### 1.1. AAA-1

### 1.2. AAA-2

4.4. Embed style

This style is not smart, but compatible with wide platforms.
With this style, html div elements are inserted automatically.

<div id="toc-title" />

# title

<!-- TOC tocDepth:2..3 chapterDepth:2..6 anchorMode:embed -->

- [1. AAA](#toc-1--aaa)
    - [1.1. AAA-1](#toc-1-1--aaa-1)
    - [1.2. AAA-2](#toc-1-2--aaa-2)

<!-- /TOC -->

<div id="toc-1--aaa" />

## 1.1. AAA

<div id="toc-1-1--aaa-1" />

### 1.1.1. AAA-1

<div id="toc-1-2--aaa-2" />

### 1.1.2. AAA-2

5. Release Notes

• See changelog.

6. Links

• Source Code
• Marketplace

7. License

Apache 2.0, See LICENSE for more information.