{"repo":"hukkin/mdformat","free":true,"listed":false,"github":"https://github.com/hukkin/mdformat","clone":"git clone https://github.com/hukkin/mdformat.git","description":"CommonMark compliant Markdown formatter","language":"Python","stars":810,"topics":["markdown","commonmark","formatter","python","cli","mdformat","pre-commit","codeformatter"],"license":"MIT","category":"cli-tools","readme_excerpt":"CommonMark compliant Markdown formatter Mdformat is an opinionated Markdown formatter that can be used to enforce a consistent style in Markdown files. Mdformat is a Unix-style command-line tool as well as a Python library. Find out more in the docs. Installing Install with CommonMark support: Install with GitHub Flavored Markdown (GFM) support: Command line usage Format files Format files README.md and CHANGELOG.md in place Format .md files in current working directory recursively Read Markdown from standard input until EOF . Write formatted Markdown to standard output. Check formatting This will not apply any changes to the files. If a file is not properly formatted, the exit code will be non-zero. Options The --exclude option is only available on Python 3.13+. Documentation This README merely provides a quickstart guide for the command line interface. For more information refer to the documentation. Here's a few pointers to get you started: - Style guide - Python API usage - Usage as a pre-commit hook - Plugin usage - Plugin development guide - List of code block formatter plugins - List of parser extension plugins - Changelog Frequently Asked Questions Why does mdformat backslash escape special syntax specific to MkDocs / Hugo / Obsidian / GitHub / some other Markdown engine? Mdformat is a CommonMark formatter. It doesn't have out-of-the-box support for syntax other than what is defined in the CommonMark specification. The custom syntax that these Markdown engines introdu","default_branch":null,"files":null,"tree":[],"storefront":"/r/hukkin","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/hukkin/mdformat/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}