跳转到主要内容

一个扩展的[CommonMark](https://spec.commonmark.org/)兼容解析器,

项目描述

MyST-Parser

注意:myst-docutils与myst-parser相同,但在sphinx中无需安装要求

Github-CI Coverage Status Documentation Status Code style: black PyPI Conda PyPI - Downloads

MyST是一种丰富且可扩展的Markdown方言,适用于技术文档和发布.

MyST是为简单、灵活和可扩展性而设计的Markdown方言。本存储库作为MST Markdown的参考实现,以及支持在Python和Sphinx中使用MST的工具集合。它包含了一个使用markdown-it-py的扩展的CommonMark-兼容解析器,以及一个允许您在Sphinx中编写MST Markdown的Sphinx扩展。

有关更多信息,请参阅MyST解析器文档.

安装

要安装MyST解析器,请在Conda环境中运行以下命令(推荐):

conda install -c conda-forge myst-docutils

或者

pip install myst-docutils

或者对于包开发

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

要在Sphinx中使用MyST解析器,只需将以下代码添加到您的conf.py文件中:extensions = ["myst_parser"]

贡献

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

项目详情


下载文件

下载适用于您的平台文件。如果您不确定选择哪个,请了解更多关于安装包的信息。

源分布

myst_docutils-4.0.0.tar.gz (94.0 kB 查看哈希值)

上传时间:

构建分布

myst_docutils-4.0.0-py3-none-any.whl (84.6 kB 查看哈希值)

上传时间: Python 3

由以下提供支持