MKDocsで数式を表示するためにKaTeXを使えるようにしてみる
はじめに
この記事では、「MKDocsでKaTeXを用いて数式表示をする方法」について書いています。
MKDocsで数式も書けると使える場面が増えて便利だなと調べ、以前に紹介しました。
更に調べたところ、以前に紹介したものはMathJaxというエンジンを用いたもので、他にもKaTexというエンジンを用いてMKDocs上で数式を書く方法もあることが分かったので導入の仕方を調べ実際に試してみた結果を記事にしてみました。
自分に向けた備忘録でもありますが、「MKDocsで数式を表示したい」や「MKDocsでKaTeXを使いたい」な人の一助になれば嬉しいです。
要点だけ
pip install markdown-katex
markdown_extensions: - markdown_katex
導入の仕方
まずはmarkdown-katexをインストールします。
pip install markdown-katex
Note
ちなみに、インストールせずに作業を進めるとMKDocsのビルド時に以下のようなエラーが出ます。
ERROR - Config value: 'markdown_extensions'. Error: Failed to load extension 'markdown_katex'. ModuleNotFoundError: No module named 'markdown_katex' Aborted with 1 Configuration Errors!
続いてはymlファイルを編集していきます。次のように書いてください
site_name: My Docs theme: name: 'mkdocs' markdown_extensions: - markdown_katex
大切なのは下の二行で、ここでmarkdown_katexを使うことを宣言しています。
これでmkdocsでkatexを使うことができるようになりました。
KaTeXでの数式の書き方
katexを書く時は
$`f(x) = e^x + x^2`$
や
```math
f(x) = e^x + x^2
```
のように書きます。逆に以下の書き方では数式と認識されないため数式の描画はされません（MathJaxとは書き方が少し違います。）
$$
f(x) = e^x + x^2
$$
さて、では実際にMKDocsでの表示のされ方を見てみましょう
Formulaの節の部分が数式で書いたものです。上で紹介された順番で書いています。
良い感じで数式が表示されてますね。
おわりに
「MKDocsでKaTeXを用いて数式表示をする方法」について解説しました。
数式も書けるようになると、更にMKDocsで書ける文書の幅が広がり、便利に使えるかと思います。
さいごに、記事を書く上で参考にしたサイトのリンクを以下に掲載します。合わせて読んでいただくと良いかと思います。
