MkDocsで脚注を付けてみる
はじめに
この記事では、「MkDocsで脚注を付ける方法」について書いています。
MkDocsでドキュメントを書くことが最近多いのですが、その使い方を色々調べる中で「知ってたら便利そう」な小ネタを知ったのが記事を書いたきっかけでした。
自分に向けた備忘録でもありますが、「MkDocsで注釈を付けたい、その方法が知りたい」な人の一助になれば嬉しいです。
注釈の付け方
mkdocs.ymlに以下の記述を加えます。
markdown_extensions: - footnotes
下に簡単な例を出すとこんな感じになります。
site_name: My Docs theme: name: 'mkdocs' markdown_extensions: - footnotes
また、markdownで注釈は以下のように書きます。
...(省略)... ## Test これ[^1] は注釈のテストです。 [^1]: ここに注釈の内容が記されます。 ...(省略)...
実際にMkDocsをビルドすると以下のように表示されます。
「Test」の項の部分が注釈を付けた箇所になりますが、「これ」の右上に注釈の番号が書かれ、またドキュメントの下に注釈の内容が書かれていることが分かるかと思います。
おわりに
「MkDocsで脚注を付ける方法」について解説しました。
ちょっとした小ネタですが、知っておくと便利かもしれません。
さいごに、記事を書く上で参考にしたサイトのリンクを以下に掲載します。合わせて読んでいただくと良いかと思います。
