[GH-ISSUE #3] MD033 "Inline HTML" should allow exceptions #1

Closed
opened 2026-03-03 01:22:54 +03:00 by kerem · 8 comments
Owner

Originally created by @rodneyrehm on GitHub (Jul 20, 2015).
Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/3

My markdown files contain certain html tags (like <kbd>) that just can't be expressed in markdown. I'd suggest to extend the configuration option to accept an array of tags that are considered safe for use in a document.

I generally want to be warned about html in my markdown, but there are situations where I actually need to use the html. I was wondering if there is any way to mark those situations inline, like you would with eslint's /*eslint-disable foobar */. (long shot, I don't see any obvious notation for this…)

Originally created by @rodneyrehm on GitHub (Jul 20, 2015). Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/3 My markdown files contain certain html tags (like `<kbd>`) that just can't be expressed in markdown. I'd suggest to extend the configuration option to accept an array of tags that are considered safe for use in a document. I generally want to be warned about html in my markdown, but there are situations where I actually need to use the html. I was wondering if there is any way to mark those situations inline, like you would with eslint's `/*eslint-disable foobar */`. (long shot, I don't see any obvious notation for this…)
kerem closed this issue 2026-03-03 01:22:55 +03:00
Author
Owner

@DavidAnson commented on GitHub (Jul 21, 2015):

FYI, what you talk about in the second paragraph is a little like mivok/markdownlint#16 and might be a nice way to handle this as a special case of a more general pattern.

<!-- gh-comment-id:123132770 --> @DavidAnson commented on GitHub (Jul 21, 2015): FYI, what you talk about in the second paragraph is a little like mivok/markdownlint#16 and might be a nice way to handle this as a special case of a more general pattern.
Author
Owner

@rodneyrehm commented on GitHub (Jul 21, 2015):

yeah, that's pretty much what I was hoping for :)

why are there two projects called markdownlint? Have you guys not tried to merge your code bases?

<!-- gh-comment-id:123206231 --> @rodneyrehm commented on GitHub (Jul 21, 2015): yeah, that's pretty much what I was hoping for :) why are there two projects called markdownlint? Have you guys not tried to merge your code bases?
Author
Owner

@DavidAnson commented on GitHub (Jul 22, 2015):

The other markdownlint is for Ruby. It didn't seem clean to turn it into a dual Ruby/JavaScript offering, so I created this one for JavaScript after checking with Mark - and then reused as much as I could.

<!-- gh-comment-id:123550804 --> @DavidAnson commented on GitHub (Jul 22, 2015): The other markdownlint is for Ruby. It didn't seem clean to turn it into a dual Ruby/JavaScript offering, so I created this one for JavaScript after checking with Mark - and then reused as much as I could.
Author
Owner

@rodneyrehm commented on GitHub (Jul 22, 2015):

ah, didn't realize it was ruby - good choice, would've done the same :)

<!-- gh-comment-id:123654312 --> @rodneyrehm commented on GitHub (Jul 22, 2015): ah, didn't realize it was ruby - good choice, would've done the same :)
Author
Owner

@DavidAnson commented on GitHub (Dec 6, 2015):

As I revisit this request now, I see that you referenced the ability to disable MD033 inline. That functionality wasn't available at the time, but is now. Is that sufficient for your needs, or are you still interested in more granular control like what your pull request implements? I assume the latter, but wanted to check with you to be sure. Thanks!

<!-- gh-comment-id:162266289 --> @DavidAnson commented on GitHub (Dec 6, 2015): As I revisit this request now, I see that you referenced the ability to disable MD033 inline. That functionality wasn't available at the time, but is now. Is that sufficient for your needs, or are you still interested in more granular control like what your pull request implements? I assume the latter, but wanted to check with you to be sure. Thanks!
Author
Owner

@rodneyrehm commented on GitHub (Dec 6, 2015):

I'm still interested in the tag based filter. It allows me to grant global exceptions for <kbd>, <var> etc. The inline exceptions (via <!-- markdownlint-disable MD033 -->) would be useful for larger constructs that are, well, the exception.

<!-- gh-comment-id:162302703 --> @rodneyrehm commented on GitHub (Dec 6, 2015): I'm still interested in the tag based filter. It allows me to grant global exceptions for `<kbd>`, `<var>` etc. The inline exceptions (via `<!-- markdownlint-disable MD033 -->`) would be useful for larger constructs that are, well, the exception.
Author
Owner

@DavidAnson commented on GitHub (Dec 16, 2015):

I believe the commit above does what you'd like. If you have any issues with it, please let me know! And thanks for your patience. :)

<!-- gh-comment-id:164999319 --> @DavidAnson commented on GitHub (Dec 16, 2015): I believe the commit above does what you'd like. If you have any issues with it, please let me know! And thanks for your patience. :)
Author
Owner

@rodneyrehm commented on GitHub (Dec 16, 2015):

very nice, thank you!

<!-- gh-comment-id:165058388 --> @rodneyrehm commented on GitHub (Dec 16, 2015): very nice, thank you!
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/markdownlint#1
No description provided.