Skip to content

Lint the Markdown files in CI - #714

Merged
bbatsov merged 4 commits into
masterfrom
markdownlint
Nov 7, 2026
Merged

bbatsov merged 4 commits into
masterfrom
markdownlint

Conversation

@bbatsov

@bbatsov bbatsov commented Nov 7, 2026

Copy link
Copy Markdown
Member

Adds the markdownlint config CIDER uses and a CI job that runs it over every Markdown file. The README needed alt text for its demo images and a few wrapped lines to pass.

It mirrors the config we use in CIDER.
Disable the line-length and duplicate-heading rules that don't fit a
changelog and drop a stray double blank line.
Give the demo images alt text, pad the table delimiter rows, wrap the
long lines and name the changelog link.
It lints every Markdown file with the config in .markdownlint-cli2.yaml.
@bbatsov
bbatsov merged commit 0ef4fdc into master Nov 7, 2026
8 checks passed
@bbatsov
bbatsov deleted the markdownlint branch November 7, 2026 09:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant