MkDocs で Mermaid を使って作図する
Mermaid を使うとテキストを記載するだけで作図を行うことが出来ます。 MkDocs 上でも Material for MkDocs の Diagrams を使うことで Mermaid を利用した作図を行うことが出来ます。 今回は MkDocs 上で Mermaid を利用して作図する方法をメモしておきます。
MkDocs¶
MkDocks 1.5.3 の Docker コンテナ
MkDocs のバージョン 1.5.3 をインストールした Docker コンテナを作成しました。 DockerHub の以下 URL に登録してあります。
MkDocs のコードハイライトでブロック毎に行番号表示する・しないを制御する
MkDocs ではコードをハイライトして表示することが出来ます。 また、コードハイライトを行う際に行番号を表示することが出来ます。 今回は「普段は行番号を表示しつつ、特定のコードブロックのみ、行番号を表示しない」方法をメモしておきます。
MkDocs でサポートされる記法
MkDocs でサポートされる記法のうち、幾つかをメモしておきます。 機能によっては事前に mkdocs.yml で有効化しておく必要があります。
MkDocs をインストールする
静的サイトジェネレーターである MkDocs に関して、日本語の情報源としては Mebiusbox さんがお書きになっている MkDocsによるドキュメント作成 が最強なのでは無いかと思います。 余談ですが 「動かして学ぶ！Rust入門」の執筆 によると Mebiusbox さんは さんは 動かして学ぶ！Rust入門 の著者でもあるそうです (すごい)。
以前に HBFM (Markdown 拡張) を追加した MkDocs の Docker イメージ というメモを書きました。 このは ハートビーツ さんが作成されたプラグインを取り込んだ MkDocs の Docker イメージを利用する前提になっています。 今回は Docker コンテナは利用せず、ローカルに MkDocs をインストールする手順をメモしておきます。