🔎 概览

🔎 概览#

MyST - Markedly Structured Text - 解析器

用于解析 MyST 的 Sphinx 和 Docutils 扩展,MyST 是一种丰富且可扩展的 Markdown 风格,用于编写技术和科学文档。


CommonMark-plus

MyST 扩展了 CommonMark 语法规范,以支持诸如表格和脚注等技术写作功能。

Typography
Sphinx 兼容

使用 MyST 角色和指令语法来充分利用 Sphinx 的全部功能,例如提示框和图表,以及所有现有的 Sphinx 扩展。

Roles and Directives
高度可配置

MyST-parser 可以在全局和单个文档级别进行配置,以修改解析行为并访问扩展语法功能。

Configuration

附加资源

MyST-Markdown VS Code 插件

对于 MyST 扩展语法高亮和创作工具

Convert existing ReStructuredText files to Markdown

Use the rst-to-myst CLI or the MySTyc interactive web interface.

markdown-it-py

符合 CommonMark 标准且可扩展的 Markdown 解析器,由 MyST-Parser 用于将源文本解析为标记(tokens)。

致谢

MyST Markdown 语言和 MyST 解析器均由开源社区 可执行图书项目 支持。