MkDocsで自動的に見出しへ連番を割り当てる

MkDocsには見出しに対して自動的に連番を割り当てるmkdocs-add-number-pluginというプラグインがあるそうです。今回は実際にこのプラグインを試してみました。

検証環境

対象	バージョン
macOS	15.6.1
mkdocs	1.6.1
mkdocs-add-number-plugin	1.2.2

サンプルのMarkdownファイル

今回は以下のサンプルを利用しました。

# Welcome to MkDocs

## Title A

### Title A-a

#### Title A-a-1

#### Title A-a-2

#### Title A-a-3

### Title A-b

#### Title A-b-1

#### Title A-b-2

## Title B

### Title B-a

### Title B-b

「add-number無し」の見え方(デフォルト)

設定ファイル

mkdocs.yml

site_name: My Docs
theme:
  name: material
  features:
    - toc.integrate
plugins:
  - search:

実際の見え方

「add-number有り」の見え方

設定ファイル

mkdocs.yml

site_name: My Docs
theme:
  name: material
  features:
    - toc.integrate
plugins:
  - search:
  - add-number:
      strict_mode: False
      order: 2

実際の見え方

見出しへ自動的に連番が割り当てられます。「order: 2」設定にしている為、レベル2以降の見出し(##)に対してのみ、連番が割り当てられています。