MkDocs¶

September 8, 2025
in MkDocs
2 min read

MkDocsでページを跨って連番を割り当てる

以前にMkDocsで自動的に見出しへ連番を割り当てるというメモを書きました。これ以外にもMkDocsにmkdocs-enumerate-headings-pluginを追加すると見出しに連番を割り当てることができます。しかも同じページ内だけではなく、異なるページも加味した上で連番を割り当てることができます。GitHubのFeaturesには以下の記載があります。

Automatically number all headings and (optionally) give each page an sequential chapter number

Great for writing (technical) reports

Compatible with plugins like awesome-pages and monorepo

Compatible with markdown_extensions like pymdownx.snippets

Compatible with themes like mkdocs-material

Easy to customize styling through CSS

今回はこのプラグインを実際に試してみます。

September 7, 2025
in MkDocs
1 min read

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

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

July 25, 2024
in MkDocs
10 min read

MkDocs で Mermaid を使って作図する

Mermaid を使うとテキストを記載するだけで作図を行うことが出来ます。 MkDocs 上でも Material for MkDocs の Diagrams を使うことで Mermaid を利用した作図を行うことが出来ます。今回は MkDocs 上で Mermaid を利用して作図する方法をメモしておきます。

April 15, 2024
in Docker, MkDocs
1 min read

MkDocks 1.5.3 の Docker コンテナ

MkDocs のバージョン 1.5.3 をインストールした Docker コンテナを作成しました。 DockerHub の以下 URL に登録してあります。

sig9/mkdocs

November 29, 2023
in MkDocs
1 min read

MkDocs のコードハイライトでブロック毎に行番号表示する・しないを制御する

MkDocs ではコードをハイライトして表示することが出来ます。また、コードハイライトを行う際に行番号を表示することが出来ます。今回は「普段は行番号を表示しつつ、特定のコードブロックのみ、行番号を表示しない」方法をメモしておきます。

November 20, 2023
in MkDocs
5 min read

MkDocs でサポートされる記法

MkDocs でサポートされる記法のうち、幾つかをメモしておきます。機能によっては事前に mkdocs.yml で有効化しておく必要があります。

November 3, 2023
in MkDocs, Python
2 min read

MkDocs をインストールする

静的サイトジェネレーターである MkDocs に関して、日本語の情報源としては Mebiusbox さんがお書きになっている MkDocsによるドキュメント作成が最強なのでは無いかと思います。余談ですが「動かして学ぶ！Rust入門」の執筆によると Mebiusbox さんはさんは動かして学ぶ！Rust入門の著者でもあるそうです (すごい)。

以前に HBFM (Markdown 拡張) を追加した MkDocs の Docker イメージというメモを書きました。このはハートビーツさんが作成されたプラグインを取り込んだ MkDocs の Docker イメージを利用する前提になっています。今回は Docker コンテナは利用せず、ローカルに MkDocs をインストールする手順をメモしておきます。