Rolling out markdownlint-cli to lint Markdown
#15
Conversation
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
jamesbraza
requested review from
MicPie,
albertbou92,
alexandonian,
nadolskit,
sidnarayanan,
sremo and
whitead
There was a problem hiding this comment.
Pull Request Overview
This PR introduces markdownlint-cli for linting Markdown, configures its rules, and updates existing documentation to comply with the new lint settings.
- Add Markdown lint configuration (line length, inline HTML rules) to
pyproject.toml - Register the
markdownlintpre-commit hook in.pre-commit-config.yaml - Adjust existing Markdown files (
README.mdandpackages/remotes/README.md) for consistent link formatting and badge syntax
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| pyproject.toml | Configure markdownlint rules and line-length limits |
| .pre-commit-config.yaml | Add markdownlint-cli hook with TOML config pointer |
| packages/remotes/README.md | Convert raw URLs to reference-style links and adjust list formatting |
| README.md | Update badge link syntax, remove HTML img tags, wrap long lines and refactor heading |
nadolskit
approved these changes
Jun 24, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Sister PR to Future-House/ldp#303