[GH-ISSUE #232] HTML checking in MD docs #200

New issue

Open

opened 2026-03-03 01:24:37 +03:00 by kerem · 4 comments

kerem commented

2026-03-03 01:24:37 +03:00

Owner

Originally created by @countofsanfrancisco on GitHub (Oct 25, 2019).
Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/232

This is an enhancement request.

It would be nice to have basic html syntax checking.
It would be nice if this tool can also check links (internal or external). However, internal links is more important for me.

Originally created by @countofsanfrancisco on GitHub (Oct 25, 2019). Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/232 This is an enhancement request. It would be nice to have basic html syntax checking. It would be nice if this tool can also check links (internal or external). However, internal links is more important for me.

kerem added the

new rule

label

2026-03-03 01:24:37 +03:00

kerem commented

2026-03-03 01:24:38 +03:00

Author

Owner

@DavidAnson commented on GitHub (Oct 25, 2019):

HTML in Markdown is somewhat discouraged, as by MD033: https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md033

What did you have in mind?

Regarding link checking, that is probably covered by some combination of #40, #68, #121, #144, #213.

@DavidAnson commented on GitHub (Oct 25, 2019): HTML in Markdown is somewhat discouraged, as by MD033: https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md033 What did you have in mind? Regarding link checking, that is probably covered by some combination of #40, #68, #121, #144, #213.

kerem commented

2026-03-03 01:24:39 +03:00

Author

Owner

@countofsanfrancisco commented on GitHub (Oct 25, 2019):

According to that rules, we can disable it or allow specific elements. MD is great but it doesn't cover some needed complexities inside of tables or in creating anchors. Things that are needed when you convert the MD to a full HTML and include things like table of contents, etc... I found using tags like ,   and <a> in side of MD tables greatly help make the HTML readable. In very rare cases we need to resort to because MD can't "merge" cells.

Long story short, for the HTML, the most common problem is forgetting the equivalent end tag. For example, if I wrote this:

<p id="an_anchor_point">

It would be nice to check that there is an end tag (i.e. ) and the id is wrapped in quotation double quotation marks. If not, call out an error.

We have multiple editors to the document and simple human mistakes occur.

I don't think you really need to go any further than that if you don't want.

@countofsanfrancisco commented on GitHub (Oct 25, 2019): According to that rules, we can disable it or allow specific elements. MD is great but it doesn't cover some needed complexities inside of tables or in creating anchors. Things that are needed when you convert the MD to a full HTML and include things like table of contents, etc... I found using tags like ``, ` ` and `<a>` in side of MD tables greatly help make the HTML readable. In very rare cases we need to resort to <table> because MD can't "merge" cells. Long story short, for the HTML, the most common problem is forgetting the equivalent end tag. For example, if I wrote this: ``` ``` It would be nice to check that there is an end tag (i.e. ``) and the id is wrapped in quotation double quotation marks. If not, call out an error. We have multiple editors to the document and simple human mistakes occur. I don't think you really need to go any further than that if you don't want.

kerem commented

2026-03-03 01:24:39 +03:00

Author

Owner

@DavidAnson commented on GitHub (Oct 25, 2019):

Makes sense, thanks!

@DavidAnson commented on GitHub (Oct 25, 2019): Makes sense, thanks!

kerem commented

2026-03-03 01:24:39 +03:00

Author

Owner

@sanmai-NL commented on GitHub (Nov 20, 2020):

You'd better enhance webhint or some other HTML linter, or use Markdown preprocessor such as mdBook that allows you to include other files as fragments, and split out the HTML source code.

@sanmai-NL commented on GitHub (Nov 20, 2020): You'd better enhance webhint or some other HTML linter, or use Markdown preprocessor such as mdBook that allows you to include other files as fragments, and split out the HTML source code.

kerem referenced this issue

2026-03-07 20:03:46 +03:00

[GH-ISSUE #200] Disable MD031 (space around code blocks) for lists? #2021