mdformat-myst is a plugin for the mdformat Markdown formatter, providing compatibility with MyST (Markedly Structured Text) Markdown syntax. It enables mdformat to correctly parse and format MyST-specific elements like directives, roles, and math blocks. The current version is 0.3.0, and it follows an active release cadence, frequently updating to support new mdformat features and MyST specifications.
pip install mdformat-mystVerified import paths — ran on the pinned version, not inferred.
To use mdformat-myst, you invoke `mdformat` from the command line or use its Python API, specifying `myst` as an enabled extension or plugin. The plugin automatically integrates with `mdformat` to handle MyST-specific syntax. The example demonstrates programmatic usage; for command line, save the MyST markdown to a file and run `mdformat <file> --plugin myst`.
Upgrade Python to 3.10 or newer. For projects requiring older Python, pin `mdformat-myst<0.2.2`.
Ensure `mdformat-gfm` is installed. If manually managing `mdformat` plugins, remove `mdformat-tables` and add `mdformat-gfm`.
Update your `requirements.txt` or `pyproject.toml` to use `mdformat-front-matters` instead of `mdformat-frontmatter`, ensuring the correct version is installed.
Always use `mdformat` as the entry point: `mdformat <file> --plugin myst` or `mdformat.text(..., extensions=('myst',))`.Run `pip install mdformat-myst` to ensure the plugin is installed in the same environment as `mdformat`.
Ensure `mdformat` and all its direct dependencies (e.g., `mdit-py-plugins`) are compatible with your `mdformat-myst` version. Try `pip install --upgrade mdformat mdformat-myst`.
Verify `mdformat-myst` is installed and `mdformat` is up-to-date (`pip install --upgrade mdformat mdformat-myst`). Also ensure the correct plugin name `myst` is used.
Upgrade your Python environment to 3.10 or newer. If you must use an older Python, downgrade `mdformat-myst` to `<0.2.2`.