[GH-ISSUE #585] MD038: allow code in nested blocks #463

New issue

Closed

opened 2026-03-03 01:27:09 +03:00 by kerem · 2 comments

kerem commented

2026-03-03 01:27:09 +03:00

Owner

Originally created by @gforcada on GitHub (Sep 22, 2022).
Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/585

We are happily using mkdocs with the popular mkdocs-material plugin. One of its plugins is admonitions, which let's you have fancy boxes with some text within it.

Unfortunately markdownlint and admonitions do not play well together if one wants to have a fancy box with some code block on it, i.e.:

To prevent you from making synatx mistakes, use `markdownlint` ✨ 

!!! example
    ```shell
    markdownlint-cli2 "docs/**/*.md"
    ```

But markdownlint will report a MD038 as there are spaces on the code.

Same happens on plain lists:

- one entry
- another one
  - see this code:
    ```shell
    markdownlint-cli2 "docs/**/*.md"
    ```

Would it be possible to either have another code that can be ignored, or check that the line that would issue a MD038 is actually within a scope/block, and if its indentation matches that of the block then it does not mark it as a problem?

i.e. this should get a warning as markdownlint-cli2 "docs/**/*.md" is indented way too much, but the examples above should be fine

- one entry
- another one
  - see this code:
    ```shell
            markdownlint-cli2 "docs/**/*.md"
    ```

Thanks for the time to build this tool!! ✨ 😄

Originally created by @gforcada on GitHub (Sep 22, 2022). Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/585 We are happily using `mkdocs` with the popular `mkdocs-material` plugin. One of its plugins is [admonitions](https://squidfunk.github.io/mkdocs-material/reference/), which let's you have fancy boxes with some text within it. Unfortunately `markdownlint` and admonitions do not play well together if one wants to have a fancy box with some code block on it, i.e.: ```markdown To prevent you from making synatx mistakes, use `markdownlint` ✨ !!! example ```shell markdownlint-cli2 "docs/**/*.md" ``` ``` But `markdownlint` will report a `MD038` as there are spaces on the code. Same happens on plain lists: ```markdown - one entry - another one - see this code: ```shell markdownlint-cli2 "docs/**/*.md" ``` ``` Would it be possible to either have another code that can be ignored, or check that the line that would issue a `MD038` is actually within a scope/block, and if its indentation matches that of the block then it does not mark it as a problem? i.e. this should get a warning as `markdownlint-cli2 "docs/**/*.md"` is indented way too much, but the examples above should be fine ```markdown - one entry - another one - see this code: ```shell markdownlint-cli2 "docs/**/*.md" ``` ``` Thanks for the time to build this tool!! ✨ 😄

kerem

2026-03-03 01:27:09 +03:00

closed this issue
added the
question
label

kerem commented

2026-03-03 01:27:10 +03:00

Author

Owner

@nschonni commented on GitHub (Sep 22, 2022):

https://github.com/DavidAnson/markdownlint/search?q=admonitions&type=issues

@nschonni commented on GitHub (Sep 22, 2022): https://github.com/DavidAnson/markdownlint/search?q=admonitions&type=issues

kerem commented

2026-03-03 01:27:10 +03:00

Author

Owner

@DavidAnson commented on GitHub (Sep 22, 2022):

Here is your plain list example; it does not produce MD038 for me. What am I missing?

https://dlaa.me/markdownlint/#%25m%23%20Issue%20585%0A%0A-%20one%20entry%0A-%20another%20one%0A%20%20-%20see%20this%20code%3A%0A%20%20%20%20%60%60%60shell%0A%20%20%20%20markdownlint-cli2%20%22docs%2F**%2F*.md%22%0A%20%20%20%20%60%60%60%0A

@DavidAnson commented on GitHub (Sep 22, 2022): Here is your plain list example; it does not produce MD038 for me. What am I missing? https://dlaa.me/markdownlint/#%25m%23%20Issue%20585%0A%0A-%20one%20entry%0A-%20another%20one%0A%20%20-%20see%20this%20code%3A%0A%20%20%20%20%60%60%60shell%0A%20%20%20%20markdownlint-cli2%20%22docs%2F**%2F*.md%22%0A%20%20%20%20%60%60%60%0A

kerem referenced this issue

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

[GH-ISSUE #463] markdownlint takes absurdly long to parse a 27,000 line table due to work for each inline incorrectly processing the entire table #2230