Skip to content

Disable additional markdown linting rules #415

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.

Sign up for GitHub

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
jbampton merged 1 commit into from
Apr 4, 2026
Merged

Disable additional markdown linting rules #415

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .github/linters/.markdown-lint.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
# https://github.com/DavidAnson/markdownlint#rules--aliases

Check failure on line 1 in .github/linters/.markdown-lint.yml

View workflow job for this annotation

GitHub Actions / 🏃🏿‍♂️‍➡️ Run prek on windows-latest 

1:60 [new-lines] wrong new line character: expected \n

# MD013/line-length Line length
MD013: false

# MD033/no-inline-html Inline HTML
MD033: false
Comment on lines +6 to +7
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot Apr 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Disabling MD033 (no-inline-html) entirely is discouraged as it allows arbitrary HTML to be mixed with Markdown, which can lead to inconsistent formatting and reduced maintainability. Instead of a global disable, it is a better practice to whitelist only the specific HTML elements that are necessary for your project (such as <br>, <details>, or <summary>).

# MD033/no-inline-html Inline HTML
MD033:
  allowed_elements: [ "br", "details", "summary" ]


# MD036/no-emphasis-as-heading Emphasis used instead of a heading
MD036: false

# MD041/first-line-heading/first-line-h1
MD041: false

# MD042/no-empty-links No empty links
MD042: false
Loading