starred/markdownlint

Fork 0

mirror of https://github.com/DavidAnson/markdownlint.git synced 2026-04-26 01:36:03 +03:00

[GH-ISSUE #641] MD038 suggested fixes do not render well on GitHub. Or, I misunderstand their purpose. #486

New issue

Closed

opened 2026-03-03 01:27:20 +03:00 by kerem · 6 comments

kerem commented

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

Owner

Originally created by @Ben-Voris on GitHub (Nov 17, 2022).
Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/641

What I want is a block of text that my user's can copy from a markdown file that includes a trailing space. E.g., something like

"prefix - "

The double quotes are to show what I want and to show that GitHub markdown renders the trailing space.

Specifically, this from MD038 - Spaces inside code span elements

Note: A single leading and trailing space is allowed by the specification and automatically trimmed (to allow for embedded backticks):

`backticks`
Note: A single leading or trailing space is allowed if used to separate code span markers from an embedded backtick:

` embedded backtick

The first example displays the a backtick, the text, and a backtick:

`backticks`

The second displays a backtick, followed by a space, followed by the text:

` embedded backtick

Other than ignoring the warning, another workaround is

prefix -

as shown here. But, at least on GitHub, that introduces a line break that I don't want.

Finally, the markdown preview in VS Code 1.73.1 appears to render these the same as GitHub, itself.

Originally created by @Ben-Voris on GitHub (Nov 17, 2022). Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/641 What I want is a block of text that my user's can copy from a markdown file that includes a trailing space. E.g., something like "`prefix - `" The double quotes are to show what I want and to show that GitHub markdown renders the trailing space. Specifically, this from [MD038 - Spaces inside code span elements](https://github.com/DavidAnson/markdownlint/blob/v0.26.2/doc/Rules.md#md038) > > Note: A single leading and trailing space is allowed by the specification and automatically trimmed (to allow for embedded backticks): > > `` `backticks` `` > Note: A single leading or trailing space is allowed if used to separate code span markers from an embedded backtick: > > `` ` embedded backtick`` > The first example displays the a backtick, the text, and a backtick: ``` `backticks` ``` The second displays a backtick, followed by a space, followed by the text: ``` ` embedded backtick ``` Other than ignoring the warning, another workaround is <pre>prefix - </pre> as shown here. But, at least on GitHub, that introduces a line break that I don't want. Finally, the markdown preview in VS Code 1.73.1 appears to render these the same as GitHub, itself.

kerem

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

closed this issue
added the
enhancement

fixed in next
labels

kerem commented

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

Author

Owner

@DavidAnson commented on GitHub (Nov 17, 2022):

MD038 exists to help authors avoid accidentally including a space on either edge of an inline code span. If you specifically want to include a space, you probably want to suppress this rule because its guidance does not apply.

@DavidAnson commented on GitHub (Nov 17, 2022): MD038 exists to help authors avoid accidentally including a space on either edge of an inline code span. If you specifically want to include a space, you probably want to suppress this rule because its guidance does not apply.

kerem commented

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

Author

Owner

@Ben-Voris commented on GitHub (Nov 18, 2022):

I thought the reason for the rule was that space would not render consistently. If that's not so, I don't understand the motivation.

@Ben-Voris commented on GitHub (Nov 18, 2022): I thought the reason for the rule was that space would not render consistently. If that's not so, I don't understand the motivation.

kerem commented

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

Author

Owner

@DavidAnson commented on GitHub (Nov 18, 2022):

Similar to MD037 and MD039, extra space on the edge of emphasis and links is usually unnecessary and probably not what the author intended. These rules call that out, but of course if that is being done intentionally, then it is perfectly appropriate to disable the rules for that line, file, or project.

@DavidAnson commented on GitHub (Nov 18, 2022): Similar to MD037 and MD039, extra space on the edge of emphasis and links is usually unnecessary and probably not what the author intended. These rules call that out, but of course if that is being done intentionally, then it is perfectly appropriate to disable the rules for that line, file, or project.

kerem commented

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

Author

Owner

@DavidAnson commented on GitHub (Nov 18, 2022):

As the "rationale" for each rule indicates, having spaces present can lead to rendering problems in some cases. In others, it is just potentially unsightly.

@DavidAnson commented on GitHub (Nov 18, 2022): As the "rationale" for each rule indicates, having spaces present can lead to rendering problems in some cases. In others, it is just potentially unsightly.

kerem commented

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

Author

Owner

@Ben-Voris commented on GitHub (Nov 18, 2022):

Thank you for the explanation.
Others might be as confused as I as to the purpose of the examples, so adding a few words about that might help.
For some reason Github does not show the close button to me. If you choose to close this, please would you do that?

@Ben-Voris commented on GitHub (Nov 18, 2022): Thank you for the explanation. Others might be as confused as I as to the purpose of the examples, so adding a few words about that might help. For some reason Github does not show the close button to me. If you choose to close this, please would you do that?

kerem commented

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

Author

Owner

@DavidAnson commented on GitHub (Nov 18, 2022):

I'll add a bit to the role description to try to explain this. Thanks.

@DavidAnson commented on GitHub (Nov 18, 2022): I'll add a bit to the role description to try to explain this. Thanks.

kerem referenced this issue

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

[GH-ISSUE #486] MD049/50: Incorrect range/fixinfo if identical errors on the same line #2248