MyST Markdown

MyST extends Markdown for technical, scientific communication and publication. It allows you to directly create “directives” and “roles” that extend markdown to support technical and scientific documents.

Directives are block-level extension points, like callout panels, tabs, figures or embedded charts; and roles are inline extension points, for components like cross-references, external references, citations, or inline math.

MyST also supports rich information about linking to other documents in common services (like Wikipedia or a DOI link), these allow for rich-previews of the links as well as easy ways to include citations.

The extensions and design of MyST is inspired by the Sphinx and reStructuredText (RST) ecosystems and is is a superset of CommonMark.

A comprehensive introduction to MyST can be found on Working with MyST Markdown — An overview of syntax features.