myst md

Domain: Documentation

🎯 Motivation

MyST Markdown lets you write sphinx documentation in Markdown instead of rst. It combines Markdown’s simplicity with sphinx’s power, making it the preferred choice for developers who already know Markdown.

πŸ“‹ Concrete Example

You write ```{note} in a .md file, and MyST renders it as an admonition box in the HTML, giving you rst-level features with Markdown syntax.

πŸ”— Analogy

MyST is like a universal adapter that lets your Markdown plug into the powerful sphinx machine. You get the best of both worlds: easy writing and rich output.