Mdformat Is An Extensible Markdown Formatter

Things on this page are fragmentary and immature notes/thoughts of the author. Please read with your own judgement!

mdformat path/to/file.md

Tips and Traps¶

1. When mdformat is used via the command-line interface, it automatically enables installed code formatter plugins and parser plugins so that you don’t have to manually specify --extensions e1 --extensions e2 .... However, when mdformat is used via the Python API, you have to manually enable plugins.

Some Useful Plugins¶

• mdformat-myst

• mdformat-ruff

• mdformat-beautysh

• mdformat-config

• mdformat-rustfmt

• mdformat-web

References¶

• mdformat @ GitHub