Markdownlint¶

Markdownlint is used to ensure consistency in the structure of the Markdown files across the docs pages.

Perform Linting¶

To run the markdownlint linter run: just lint-markdown.

The Rules for markdownlint explain what's enforced with examples.

In rare cases, it's necessary to ignore markdown lint violations.

The .markdownlint-cli2.yaml configuration file is used for IDE integration and for the checks that run during a Pull Request.

IDE Integration

Check out the Local Development page to learn more about IDE integration for markdownlint.