Allows you to write Sphinx documentation using Markdown instead of reStructuredText. Supports standard Markdown plus additional syntax for Sphinx features like cross-references and directives.

What you get

• Write .md files instead of .rst files
• Use familiar GitHub-flavored Markdown syntax
• Access all Sphinx features through extended Markdown syntax
• Cross-reference between documents with {doc} and {ref}
• Include code blocks, math equations, and directives
• Better editor support and preview capabilities

Syntax examples

Cross-references:

See {doc}`installation` for setup instructions.
Link to {ref}`api-reference` section.

Math equations:

$$
E = mc^2
$$

Directives:

```{note}
This is a note directive.

## Migration from reStructuredText

MyST covers most reStructuredText features:
- All standard directives (note, warning, code-block, etc.)
- Cross-references and links
- Tables and figures
- Math support
- Custom roles and directives

## Configuration

```python
# conf.py
extensions = ['myst_parser']

# Optional: enable additional features
myst_enable_extensions = [
    "colon_fence",      # ::: instead of ```
    "deflist",          # Definition lists
    "html_image",       # HTML img tags
]