| sd_hide_title |
|---|
true |
::::{grid} :reverse: :gutter: 3 4 4 4 :margin: 1 2 1 2
:::{grid-item} :columns: 12 4 4 4
:width: 200px
:class: sd-m-auto
:::
:::{grid-item} :columns: 12 8 8 8 :child-align: justify :class: sd-fs-5
A Sphinx and Docutils extension to parse MyST, a rich and extensible flavour of Markdown for authoring technical and scientific documentation.
:ref-type: doc
:color: primary
:class: sd-rounded-pill
Get Started
:::
::::
::::{grid} 1 2 2 3 :gutter: 1 1 1 2
:::{grid-item-card} {octicon}markdown;1.5em;sd-mr-1 CommonMark-plus
:link: syntax/core
:link-type: ref
MyST extends the CommonMark syntax specification, to support technical authoring features such as tables and footnotes.
+++ Learn more » :::
:::{grid-item-card} {octicon}plug;1.5em;sd-mr-1 Sphinx compatible
:link: roles-directives
:link-type: ref
Use the MyST role and directive syntax to harness the full capability of Sphinx, such as admonitions and figures, and all existing Sphinx extensions.
+++ Learn more » :::
:::{grid-item-card} {octicon}tools;1.5em;sd-mr-1 Highly configurable
:link: configuration
:link-type: doc
MyST-parser can be configured at both the global and individual document level, to modify parsing behaviour and access extended syntax features.
+++ Learn more » :::
::::
MyST-Markdown VS Code extension : For MyST extended syntax highlighting and authoring tools.
Convert existing ReStructuredText files to Markdown : Use the rst-to-myst CLI or the MySTyc interactive web interface
MyST-NB : A Sphinx and Docutils extension for compiling Jupyter Notebooks into high quality documentation formats, built on top of the MyST-Parser.
Jupyter Book : An open source project for building beautiful, publication-quality books and documents from computational material, built on top of the MyST-Parser and MyST-NB.
The Jupyter Book gallery : Examples of documents built with MyST.
Javascript MyST parser : The mystjs Javascript parser, allows you to parse MyST in websites.
markdown-it-py : A CommonMark-compliant and extensible Markdown parser, used by MyST-Parser to parse source text to tokens.
The MyST markdown language and MyST parser are both supported by the open community, The Executable Book Project.
:hidden:
intro.md
:hidden:
:caption: Guides
syntax/syntax
syntax/optional
syntax/roles-and-directives.md
configuration.md
docutils.md
faq/index.md
develop/index.md
:hidden:
:caption: Reference
develop/_changelog.md
syntax/reference
develop/background.md
api/reference.rst