Repository navigation
Lint Markdown pages on pull requests - #312
Merged
Merged
Conversation
Runs markdownlint-cli2 on content pages for each PR. Rules the existing pages break are off for now so the check starts green and catches new breakage such as broken reference links and bad tables.
Member
Author
|
Rules turned off in Off because they clash with how the site is written: MD013 (line length), MD033 (inline HTML) and MD041 (first line heading, as the title comes from the Off because existing pages break them (225 of 287 pages). Each rule shows the pages that fail it and the number of issues per page.
|
jbampton
reviewed
Oct 15, 2026
jbampton
left a comment
jbampton
left a comment
Member
There was a problem hiding this comment.
I would prefer to use the ASF approved prek-action:
https://github.com/apache/infrastructure-actions/blob/main/approved_patterns.yml#L234
And then we can add all the linters and scripts in the pre-commit config in one place
https://github.com/j178/prek-action
Benefits are that we can run this on our local machines with prek as well as running on the GitHub CI
Moves markdownlint-cli2 into .pre-commit-config.yaml and runs it with the ASF approved prek-action, so the same checks run locally with prek and in CI.
Member
Author
|
Good idea, switched to prek. |
cottage14
approved these changes
Oct 19, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a markdownlint-cli2 check on pull requests that touch content pages. Pelican metadata and the theme are skipped. Rules the current pages break are off, so the check passes on all 287 pages today and catches new problems such as undefined reference links, empty links and table column mismatches. Each disabled rule can be turned back on as pages are cleaned up.