マークダウン¶

マークダウンは、飾り気のないプレーンテキストの書式設定構文を持つ軽量マークアップ言語です。構文的に異なる フレーバー がたくさんあります。マークダウンベースのドキュメントをサポートするために、Sphinx では MyST-Parser を使用できます。MyST-Parser は markdown-it-py へのドキュメントブリッジです。markdown-it-py は CommonMark マークダウンフレーバーを解析する Python パッケージです。

設定¶

マークダウンをサポートするように Sphinx プロジェクトを設定するには、以下のように進めます。

マークダウンパーサー MyST-Parser をインストールします。
```
pip install --upgrade myst-parser
```
list of configured extensions に myst_parser を追加します。
```
extensions = ['myst_parser']
```
注意

MyST-Parser には Sphinx 2.1 以降が必要です。
.md 以外の拡張子を持つマークダウンファイルを使用する場合は、source_suffix 変数を調整します。次の例では、Sphinx で拡張子が .md と .txt のすべてのファイルをマークダウンとして解析するように設定します。
```
source_suffix = {
    '.rst': 'restructuredtext',
    '.txt': 'markdown',
    '.md': 'markdown',
}
```
標準の CommonMark がサポートしていないカスタム構文を許可するように MyST-Parser をさらに設定できます。MyST-Parser ドキュメントで詳細を確認してください。