Markdown¶

Markdown 是一種輕量級標記語言，具有簡化的純文字格式語法。它以許多語法上不同的風格存在。為了支援基於 Markdown 的文件，Sphinx 可以使用 MyST-Parser。MyST-Parser 是 Docutils 到 markdown-it-py 的橋樑，markdown-it-py 是一個 Python 套件，用於解析 CommonMark Markdown 風格。

設定¶

要為您的 Sphinx 專案設定 Markdown 支援，請依照以下步驟進行

安裝 Markdown 解析器 MyST-Parser
```
pip install --upgrade myst-parser
```
將 myst_parser 新增至 已設定擴充功能的列表
```
extensions = ['myst_parser']
```
注意

MyST-Parser 需要 Sphinx 2.1 或更新版本。
如果您想使用副檔名不是 .md 的 Markdown 檔案，請調整 source_suffix 變數。以下範例將 Sphinx 設定為解析所有副檔名為 .md 和 .txt 的檔案作為 Markdown
```
source_suffix = {
    '.rst': 'restructuredtext',
    '.txt': 'markdown',
    '.md': 'markdown',
}
```
您可以進一步設定 MyST-Parser 以允許標準 CommonMark 不支援的自訂語法。請在 MyST-Parser 文件中閱讀更多資訊。