はじめに
この記事では、「MKDocsで数式を書く方法」について書いています。
最近MKDocsを使って資料を書く機会が多いのですが、数式を扱うことがある人なら、MKDocsで数式を書けると便利かと思います。
自分に向けた備忘録でもありますが、「MKDocsで数式を書きたい」な人の一助になれば嬉しいです。
本文
今、以下の数式（何が表示されるかは後ほど分かります）をMKDocsで表示させたいとします。
$$
\int^{b}_{a} f(x) dx
$$
まずは何もしてない状態で、ymlファイルは以下のような記述です。
site_name: My Docs theme: name: 'mkdocs'
このとき、MKDocs上では以下のような表示で、Formulaの節に数式が表示してほしいのですが上手く表示されてません
では数式が表示されるようにしていきましょう。
まず、次のコマンドを実行してpython-markdown-mathをインストールしてください
pip install python-markdown-math
続いてはymlファイルの中に記述を足します。以下のように記述してください
site_name: My Docs
theme:
name: 'mkdocs'
markdown_extensions:
- mdx_math
extra_javascript:
- http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML
ポイントは２つです。
+ markdown_extensions:にmdx_mathを加える
+ extra_javascript:にmathjaxのURLを加える
さて、ここまで作業が実施できたら、改めてMKDocsの表示を確認してみましょう
Formulaの節の部分、無事に数式が表示されてます。（表示したい数式は積分式でした）
おわりに
「MKDocsで数式を書く方法」について解説しました。
数式も書けるようになると、更にMKDocsで書ける文書の幅が広がり、便利に使えるかと思います。
さいごに、記事を書く上で参考にしたサイトのリンクを以下に掲載します。合わせて読んでいただくと良いかと思います。
