MyST Parser

MyST-解析器

MyST 是 Markdown 的丰富且可扩展的风格，旨在用于技术文档和发布。

MyST 是一种 Markdown 风格，旨在实现简单性、灵活性和可扩展性。该存储库用作 MyST Markdown 的参考实现，以及支持在 Python 和 Sphinx 中使用 MyST 的工具集合。它包含使用markdown-it-py的扩展 CommonMark 兼容解析器，以及允许您在 Sphinx 中编写 MyST Markdown 的 Sphinx 扩展。

有关详细信息，请参阅 MyST 解析器文档。

安装

要安装 MyST 解析器，请在 Conda 环境中运行以下命令（推荐）：

conda install -c conda-forge myst-parser

或者

pip install myst-parser

或者用于包开发：

git clone https://github.com/executablebooks/MyST-Parser
cd MyST-Parser
git checkout master
pip install -e .[code_style,linkify,testing,rtd]

要在 Sphinx 中使用 MyST 解析器，只需添加： extensions = ["myst_parser"]到你的conf.py中。

贡献

我们欢迎所有贡献！有关更多详细信息，请参阅贡献指南。