Disable additional markdown linting rules - #415
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the markdown linter configuration to disable rules for inline HTML (MD033) and first-line headings (MD041). The feedback provided suggests that rather than disabling the MD033 rule globally, it is better practice to whitelist specific allowed HTML elements to ensure better maintainability and formatting consistency.
| # MD033/no-inline-html Inline HTML | ||
| MD033: false |
There was a problem hiding this comment.
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" ]
1 participant
No description provided.