MyST - 标记的结构化文本 _images/logo-square.svg

PyPI Conda

MyST 是 Markdown 的一个丰富且可扩展的版本,用于技术文档和发布

MyST 是一款基于简单性、灵活性和可扩展性而设计的 markdown。以下是一些主要功能

MyST is a superset of CommonMark Markdown. Any CommonMark document is also MyST-compliant.

MyST 提供了角色指令,允许你扩展 MyST 的功能。

MyST is inspired by Sphinx, and comes with its own Sphinx parser. Write your Sphinx docs in Markdown, or convert existing RST to Markdown from the CLI or using an interactive web interface!

This MyST parser is built on top of the markdown-it-py package, an pluggable Python parser for Markdown.

The Javascript parser builds on markdown-it, and allows you to parse MyST in websites.

找到合理的文档资源

这个文档被组织成几个主要的部分。教程 是 MyST Markdown 的逐步介绍性指南。主题指南 涵盖更深入的特定领域,并组织为离散的 “how-to” 节。参考 详细描述了 MyST 解析器的 API/语法等细节。

此外,这里有一些建议来帮助你开始。

入门 MyST

在 Sphinx 中开始使用 MyST:逐步的教程。

The MyST Syntax Guide:讨论了主要的 MyST 语法组件。

The Sphinx guide:如何使用 MyST 与你的 Sphinx 文档。

了解更多关于 MyST 的信息

Optional MyST Syntaxes:你可以启用额外的语法来实现额外的功能。

Python API 指南:用 Python 解析和渲染 MyST。

Background and explanation:对 MyST markdown 的背景理解和讨论。

获取灵感

Jupyter Book:一个建立在 MyST 解析器之上的开源项目。用于从计算材料中构建漂亮的、具有出版质量的书籍和文档。。

Jupyter Book 画廊:用 MyST 建立的文档的例子。

致谢

MyST markdown 和 MyST 解析器都是由开放社区 Executable Book 项目 支持的。