[GH-ISSUE #522] Should I NOT be using this for reStructured Text (Sphinx)? #426

New issue

Closed

opened 2026-03-03 01:26:48 +03:00 by kerem · 1 comment

kerem commented

2026-03-03 01:26:48 +03:00

Owner

Originally created by @FrightRisk on GitHub (May 4, 2022).
Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/522

I have been using this for a while and it seem to work for catching errors, but it doesn't like things like headings with over and under tags, which is standard ex:

############
Heading One
############

It says "first line heading should be a top level heading"

Originally created by @FrightRisk on GitHub (May 4, 2022). Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/522 I have been using this for a while and it seem to work for catching errors, but it doesn't like things like headings with over and under tags, which is standard ex: ############ Heading One ############ It says "first line heading should be a top level heading"

kerem

2026-03-03 01:26:48 +03:00

closed this issue
added the
question
label

kerem commented

2026-03-03 01:26:49 +03:00

Author

Owner

@DavidAnson commented on GitHub (May 4, 2022):

The CommonMark specification supports two syntaxes for headings and what's shown above is neither of them. This library is intended for CommonMark syntax and the reported issue is correct in that context. Using this library for other syntaxes can result in "false" issues like this. You may wish to turn such rules off in your configuration.

See sections 4.2 and 4.3: https://spec.commonmark.org/0.30/

@DavidAnson commented on GitHub (May 4, 2022): The CommonMark specification supports two syntaxes for headings and what's shown above is neither of them. This library is intended for CommonMark syntax and the reported issue is correct in that context. Using this library for other syntaxes can result in "false" issues like this. You may wish to turn such rules off in your configuration. See sections 4.2 and 4.3: https://spec.commonmark.org/0.30/

kerem referenced this issue

2026-03-07 20:05:31 +03:00

[GH-ISSUE #426] Rules MD041 and MD033 aren't compatible with default configuration #2203