starred/markdownlint

Fork 0

mirror of https://github.com/DavidAnson/markdownlint.git synced 2026-04-25 17:26:22 +03:00

[GH-ISSUE #1191] MD033: Organizing information with collapsed sections #2483

New issue

Closed

opened 2026-03-07 20:08:11 +03:00 by kerem · 7 comments

kerem commented

2026-03-07 20:08:11 +03:00

Owner

Originally created by @Obegg on GitHub (Apr 28, 2024).
Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/1191

According to github docs: https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-collapsed-sections

I use:

<details><summary>
Example (Click to expand):
</summary>

But I get error:

MD033/no-inline-html: Inline HTML [Element: details]

What should I do?

Originally created by @Obegg on GitHub (Apr 28, 2024). Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/1191 According to github docs: https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-collapsed-sections I use: ``` <details><summary> Example (Click to expand): </summary> ``` But I get error: ``` MD033/no-inline-html: Inline HTML [Element: details] ``` What should I do?

kerem

2026-03-07 20:08:11 +03:00

closed this issue
added the
question
label

kerem commented

2026-03-07 20:08:12 +03:00

Author

Owner

@DavidAnson commented on GitHub (Apr 29, 2024):

If you want to include inline HTML in your Markdown, you should disable the no-inline-html rule. The README shows multiple ways to do so.

@DavidAnson commented on GitHub (Apr 29, 2024): If you want to include inline HTML in your Markdown, you should disable the `no-inline-html` rule. The README shows multiple ways to do so.

kerem commented

2026-03-07 20:08:12 +03:00

Author

Owner

@Obegg commented on GitHub (Apr 29, 2024):

let's assume I don't want inline HTML - how do I get the same result (collapsed section)?

@Obegg commented on GitHub (Apr 29, 2024): let's assume I don't want inline HTML - how do I get the same result (collapsed section)?

kerem commented

2026-03-07 20:08:13 +03:00

Author

Owner

@DavidAnson commented on GitHub (Apr 29, 2024):

I don't think the CommonMark specification (or GFM extensions) offers a way to do that.

@DavidAnson commented on GitHub (Apr 29, 2024): I don't think the CommonMark specification (or GFM extensions) offers a way to do that.

kerem commented

2026-03-07 20:08:13 +03:00

Author

Owner

@Obegg commented on GitHub (Apr 29, 2024):

So if I understand correctly - this error can't be fixed since there's no way to create collapsed sections without using inline HTML,.
If so - then I guess this extension need to add an exception whenever it detects inline HTML for collapsed sections such as <details> and <summery>

@Obegg commented on GitHub (Apr 29, 2024): So if I understand correctly - this error can't be fixed since there's no way to create collapsed sections without using inline HTML,. If so - then I guess this extension need to add an exception whenever it detects inline HTML for collapsed sections such as `<details>` and `<summery>`

kerem commented

2026-03-07 20:08:13 +03:00

Author

Owner

@DavidAnson commented on GitHub (Apr 29, 2024):

There are many things that can be done in HTML that cannot be done in Markdown. If you want to do many of them, you can disable this rule. If you want to do some of them, you can customize the rule to allow the relevant elements: https://github.com/DavidAnson/markdownlint/blob/main/doc/md033.md

@DavidAnson commented on GitHub (Apr 29, 2024): There are many things that can be done in HTML that cannot be done in Markdown. If you want to do many of them, you can disable this rule. If you want to do some of them, you can customize the rule to allow the relevant elements: https://github.com/DavidAnson/markdownlint/blob/main/doc/md033.md

kerem commented

2026-03-07 20:08:13 +03:00

Author

Owner

@Obegg commented on GitHub (Apr 29, 2024):

But it should not be custom specifically for me, it should be added globally, I'm not the only one who uses this extension and has collapsed sections.

@Obegg commented on GitHub (Apr 29, 2024): But it should not be custom specifically for me, it should be added globally, I'm not the only one who uses this extension and has collapsed sections.

kerem commented

2026-03-07 20:08:13 +03:00

Author

Owner

@DavidAnson commented on GitHub (Apr 30, 2024):

The rule exists to block HTML and keep Markdown content pure - for people who want that. The specific scenario raised above does not seem to be more special than any other. In fact, this issue may be the first time it has come up.

@DavidAnson commented on GitHub (Apr 30, 2024): The rule exists to block HTML and keep Markdown content pure - for people who want that. The specific scenario raised above does not seem to be more special than any other. In fact, this issue may be the first time it has come up.