Material for MKDocでチェックリストを使う方法

はじめに

この記事では、「Material for MKDocでチェックリストを使う方法」について書いています。

最近Material for MKDocでドキュメントを書いているんですが、MKDocでチェックリストを書こうとしても下図(CheckListの項の部分)のように正しく表示されず、その解決策を探していたのが記事を書いたきっかけでした。

自分に向けた備忘録の意味もありますが、「同じようにMaterial for MKDocでチェックリストを書きたいけど書けなくて困ってる」な人の一助になれば嬉しいです。

解決策

以下のサイトに書かれていました。

dev.classmethod.jp

mkdocs.ymlに以下の記述を足せばよいそうです。

markdown_extensions:
  - pymdownx.tasklist:

実際にやってみたところ、無事にチェックリストが正しく表示されました。

おわりに

「Material for MKDocでチェックリストを使う方法」について解説しました。

まさか設定しないとチェックリスト使えないとは思いませんでした。

同じようにお困りの方の一助になれば幸いです。