PyMarkdown is primarily a Markdown linter. To ensure that the Markdown linting is conducted with the highest attention to detail, its linting rules analyze the tokens produced by the project’s own Markdown parser.
The project’s Markdown parser aims to be highly compliant to both the GitHub Flavored Markdown specification and the CommonMark specification. This is important as over 90% of the existing parsers are mostly compliant to one of those two specifications. By the parser adhering to those specifications, there’s a high degree of confidence that the rules written are based on solid information about the structure of the Markdown documents that they are evaluating. Since the rules have precise information on how compliant parsers view the structure of a given Markdown document, each rule can make the best decision possible on whether it should trigger a failure or not.
While PyMarkdown is primarily a Markdown linter, the breadth of the application has grown over the years of its development. In scan mode, the linter can detect Markdown issues using a healthy set of Markdown specific rules. In fix mode, certain Markdown failures can be automatically corrected without external involvement. While fix mode is a relatively new effort, it provides a measurable benefit.
This is free and open source software.
Website: github.com/jackdewinter/pymarkdown
Support:
Developer: Jack De Winter
License: MIT License
PyMarkdown is written in Python. Learn Python with our recommended free books and free tutorials.
Related Software
| Markdown Linters | |
|---|---|
| markdownlint | Static analysis tool for Node.js |
| textlint | Pluggable linting tool for text and markdown |
| rumdl | Modern Markdown linter and formatter |
| MegaLinter | Analyzes the consistency of your code |
| remark-lint | Check Markdown code style |
| markdownlint-ruby | Tool to check markdown files and flag style issues |
| PyMarkdown | Markdown linter |
| Mado | Check Markdown documents for style and formatting issues, |
| gomarklint | Keep documentation quality under control |
Read our verdict in the software roundup.
 Explore our comprehensive directory of recommended free and open source software. Our carefully curated collection spans every major software category.This directory is part of our ongoing series of informative articles for Linux enthusiasts. It features hundreds of detailed reviews, along with open source alternatives to proprietary solutions from major corporations such as Google, Microsoft, Apple, Adobe, IBM, Cisco, Oracle, and Autodesk. You’ll also find interesting projects to try, hardware coverage, free programming books and tutorials, and much more. Discovered a useful open source Linux program that we haven’t covered yet? Let us know by completing this form. |