Markdown and ReStructuredText Linting#

Applies to Linux and Windows

2023-10-20

2 min read time

rocm-docs-core has linting to ensure correct Markdown and ReStructuredText formatting on every pull request (PR) via GitHub Actions.

If a PR fails linting, the errors must be addressed before it can be merged.

The results of linting is viewable in the “Checks” tab for a PR.

Markdown Linting#

The current linter used for Markdown is markdownlint, which uses the following rules.

Optional#

markdownlint can also be installed and run locally using the markdownlint extension on Visual Studio Code.