markdownlint
Markdown lint tool (by markdownlint)
markdownlint
A Node.js style checker and lint tool for Markdown/CommonMark files. (by DavidAnson)
markdownlint | markdownlint | |
---|---|---|
2 | 10 | |
1,877 | 5,139 | |
2.0% | 1.7% | |
6.4 | 9.4 | |
over 1 year ago | 6 days ago | |
Ruby | JavaScript | |
MIT License | MIT License |
The number of mentions indicates the total number of mentions that we've tracked plus the number of user suggested alternatives.
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
markdownlint
Posts with mentions or reviews of markdownlint.
We have used some of these posts to build our list of alternatives
and similar projects. The last one was on 2021-08-19.
-
Markdown Linting
markdownlint is a node.js markdown linter that is easy to install and easy to customize. It is based on an earlier Ruby tool, also called markdownlint. Both are great, but the Node.js tool is easy to install and easy to customize.
-
Docker Build `--replace`
An example of where this can be convenient is when you want to use an external program or project that uses a language that isn't supported by your project. For example, the build process for this blog's content uses Node.js, but consider the case where I wanted to use a Markdown linter defined in Ruby, such as Markdownlint. One option is to add a Ruby installation directly to the definition of the build environment, but this has a few disadvantages:
markdownlint
Posts with mentions or reviews of markdownlint.
We have used some of these posts to build our list of alternatives
and similar projects. The last one was on 2025-04-22.
-
The Tortoise and the Hare: do AI Agents Really Help for Software Development?
While the summary, walkthrough, and disregard for best practices were unsatisfying, one unexpected benefit emerged: the integration of linting feedback directly within the pull request comments. It provided nitpicks from linting tools (in this case markdownlint. On one side, it is very disappointing to see that the AI agent did nothing more than lint the code and generate a nice comment out of the output. On the other hand it is quite nice that it introduces "quality gates" such as linting without me having to write a pipeline for it. Moreover, producing easily digestible output from a linter is nothing to be underestimated. The quality of life of having this directly as a comment rather than having to go through pipeline logs to read the raw linter output is quite nice. Is it worth two dozen USD per month? No, definitely not!
-
First Contribution
Since the maintainer mentioned it was a copy-paste job, I went looking for the existing release notes. I figured the first place to look would be the releases on GitHub and found them right away. I did make some adjustments such as removing the GitHub changelogs and any references to them, since the previous release notes didn't include them, although I did notice the previous release notes didn't bother to remove any mentions of the changelogs even though they're absent from the docs. The markdown file was also inconsistently formatted, and links in the GitHub release notes were missing from the ones in the docs. Nevertheless, I figured I should ensure my contribution maintains a high standard, so I used markdownlint for my additions and made sure to move any links over, especially since many of them linked to contributors' GitHub profiles. One of the releases also didn't have any notes at all, but I couldn't just remove it. I also couldn't just have a heading with no body. This release was a release candidate for a minor version and there were several others like it with brief release notes simply stating that they were pre-release builds for the next minor version, so I copied the same format.
-
Streamline Your Workflow: A Guide to Normalising Git Commit and Push Processes
There are more linting tools that I won't go into deeply, but you can integrate them with lint-staged. For example, you can lint your CSS content with Stylelint, or even lint your README files with markdownlint, etc.
-
Blogging in Djot Instead of Markdown
Some of Djot's features can be achieved by using markdownlint though: https://github.com/DavidAnson/markdownlint
-
Recommended Linters
markdownlint - A Node.js style checker and lint tool for Markdown/CommonMark files.
-
Regal v0.14.0 released
Improvements - The prefer-some-in-iteration rule will by default no longer flag iteration where a sub-attribute is used, like input[_].item - The use-in-operator rule has been extended to include more types of items, leading to better discovery of locations where in should be used - Remove replace directive in go.mod that made hard to integrate Regal as a library - The project now uses markdownlint to ensure consistent formatting of its documentation - The Go API now allows reading custom rules from an fs.FS filesystem
-
Project idea: port markdownlint to Rust
People are always looking for simple projects to learn Rust with, so here's one for anyone who's currently looking. Port markdownlint to Rust. Markdownlint is ~3.3k lines of JavaScript (including the lint implementation themselves!), so I reckon it's pretty doable.
-
VS Code - Catch errors in your markdown files
The markdownlint VS Code extension is powered by the Node library of the same name. Its usage is quite similar to ESLint. It has a set of rules that can be configured, errors are highlighted, and you can automatically fix simple errors.
-
Markdown Linting
Markdown Lint
-
10 Best Visual Studio Code Extensions for Flutter Development
There are no compilers in the Flutter project that guarantee to find issues in README.md or CHANGELOG.md files. To remedy this, the Markdownlint plugin provides a set of guidelines to encourage Markdown file standards and uniformity. You can use this extension to check for problems locally and verify the content before publishing it live. Browse the user manual to learn more about rules.
What are some alternatives?
When comparing markdownlint and markdownlint you can also consider the following projects:
vale - :pencil: A markup-aware linter for prose built with speed and extensibility in mind.
remark-lint - plugins to check (lint) markdown code style
vale-styles - Checks for Vale based on popular style guides
docs - Linode guides and tutorials.
vscode-markdownlint - Markdown linting and style checking for Visual Studio Code