网页 综合 更新时间 2026-11-14 16:30:09

Markdown — Sphinx documentation

自动蜘蛛 www.sphinx-doc.org 正文约 887 字
Markdown is a lightweight markup language with a simplistic plain text formatting syntax. It exists in many syntactically different flavors. To support Markdown-based documentation, Sphinx can use MyST-Parser. MyST-Parser is a Docutils bridge to markdown-it-py, a Python package for parsing the CommonMark Markdown flavor.
To configure your Sphinx project for Markdown support, proceed as follows:
Install the Markdown parser MyST-Parser:
Add myst_parser to the list of configured extensions:
MyST-Parser requires Sphinx 2.1 or newer.
If you want to use Markdown files with extensions other than .md, adjust the source_suffix variable. The following example configures Sphinx to parse all files with the extensions .md and .txt as Markdown:
You can further configure MyST-Parser to allow custom syntax that standard CommonMark doesn’t support. Read more in the MyST-Parser documentation.
访问原文 返回搜索 https://www.sphinx-doc.org/en/master/usage/extensions/../markdown.html
本页为82搜索生成的网页快照,内容来自站内索引;演示数据的原文链接仅作示例。