-
Notifications
You must be signed in to change notification settings - Fork 3.5k
CI: Lint all Markdown files in the project #14937
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
josevalim
merged 4 commits into
elixir-lang:main
from
eksperimental-forks:feature/ci-lint-all-markdownfiles
Nov 21, 2025
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
e972459
Format all Markdown files according to Markdownlint rules
eksperimental 13da3a6
Add .markdownlint-cli2.jsonc
eksperimental 5bd0f99
CI: Lint all Markdown files in the project
eksperimental c0d4d55
Merge .markdownlint.jsonc into .markdownlint-cli2.jsonc
eksperimental File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| // SPDX-FileCopyrightText: 2021 The Elixir Team | ||
| { | ||
| "globs": [ | ||
| "**/*.md" | ||
| ], | ||
| "ignores": [ | ||
| ".git/**" | ||
| ], | ||
| "gitignore": true, | ||
| "config": { | ||
| // Consecutive header levels (h1 -> h2 -> h3). | ||
| "MD001": false, | ||
| // Header style. We use #s. | ||
| "MD003": { | ||
| "style": "atx" | ||
| }, | ||
| // Style of unordered lists.. | ||
| "MD007": { | ||
| "indent": 2, | ||
| "start_indented": true | ||
| }, | ||
| // Line length. Who cares. | ||
| "MD013": false, | ||
| // This warns if you have "console" or "shell" code blocks with a dollar sign $ that | ||
| // don't show output. We use those a lot, so this is fine for us. | ||
| "MD014": false, | ||
| // Multiple headings with the same content. That's fine. | ||
| "MD024": false, | ||
| // Some headers finish with ! because it refers to a function name | ||
| "MD026": false, | ||
| // Allow empty line between block quotes. Used by contiguous admonition blocks. | ||
| "MD028": false, | ||
| // Allowed HTML inline elements. | ||
| "MD033": { | ||
| "allowed_elements": [ | ||
| "h1", | ||
| "a", | ||
| "br", | ||
| "img", | ||
| "picture", | ||
| "source", | ||
| "noscript", | ||
| "p", | ||
| "script" | ||
| ] | ||
| }, | ||
| // This warns if you have spaces in code blocks. Sometimes, that's fine. | ||
| "MD038": false, | ||
| // Code block style. We don't care if it's fenced or indented. | ||
| "MD046": false, | ||
| // Our tables are too large to align. | ||
| "MD060": false | ||
| } | ||
| } | ||
This file was deleted.
Oops, something went wrong.
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
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
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
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
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.
Uh oh!
There was an error while loading. Please reload this page.