Skip to content

Disable additional markdown linting rules#415

Merged
jbampton merged 1 commit intomainfrom
jbampton-patch-2
Apr 4, 2026
Merged

Disable additional markdown linting rules#415
jbampton merged 1 commit intomainfrom
jbampton-patch-2

Conversation

@jbampton
Copy link
Copy Markdown
Member

@jbampton jbampton commented Apr 4, 2026

No description provided.

@jbampton jbampton self-assigned this Apr 4, 2026
@jbampton jbampton added this to Next Apr 4, 2026
@jbampton jbampton added this to the Hackfest milestone Apr 4, 2026
@github-project-automation github-project-automation bot moved this to In progress in Next Apr 4, 2026
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

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.

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

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" ]

@jbampton jbampton merged commit 42c680e into main Apr 4, 2026
12 of 13 checks passed
@jbampton jbampton deleted the jbampton-patch-2 branch April 4, 2026 07:13
@github-project-automation github-project-automation bot moved this from In progress to Done in Next Apr 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant