starred/markdownlint

Fork 0

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

[GH-ISSUE #810] Support underlining style via `_` (underscores) and italics via `*` (asterisks) simultaneously #538

New issue

Closed

opened 2026-03-03 01:27:50 +03:00 by kerem · 5 comments

kerem commented

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

Owner

Originally created by @redactedscribe on GitHub (May 8, 2023).
Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/810

Regarding MD049: The only options are asterisk / consistent / underscore. If we could have a mixed or off option, we could use * for emphasis (italicisation) and _ for underlining without markdownlint complaining that we have inconsistent emphasis styling in play. This however would give up the checks we have for emphasising which isn't ideal.

Maybe some specific support could be given to underlining so that markdownlint could ensure we're using asterisks for emphasis and underscores for underlining? I don't know how common support for underlining in Markdown parsers is, but the Markdown Extended VS Code extension enables support for it (via something called markdown-it I think) and it would be cool if markdownlint could support underlining too.

Thanks.

markdownlint 0.50.0

Originally created by @redactedscribe on GitHub (May 8, 2023). Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/810 [Regarding MD049](https://github.com/DavidAnson/markdownlint/blob/main/doc/md049.md): The only options are `asterisk` / `consistent` / `underscore`. If we could have a `mixed` or `off` option, we could use `*` for emphasis (italicisation) and `_` for underlining without markdownlint complaining that we have inconsistent emphasis styling in play. This however would give up the checks we have for emphasising which isn't ideal. Maybe some specific support could be given to underlining so that markdownlint could ensure we're using asterisks for emphasis and underscores for underlining? I don't know how common support for underlining in Markdown parsers is, but the [Markdown Extended VS Code extension](https://marketplace.visualstudio.com/items?itemName=jebbs.markdown-extended) enables support for it (via something called markdown-it I think) and it would be cool if markdownlint could support underlining too. Thanks. markdownlint 0.50.0

kerem

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

closed this issue
added the
question
label

kerem commented

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

Author

Owner

@nschonni commented on GitHub (May 8, 2023):

"Underlining" isn't part of CommonMark spec https://spec.commonmark.org/0.30/. There asterisks and underscore both produce <em> elements only in compliant parsers

@nschonni commented on GitHub (May 8, 2023): "Underlining" isn't part of CommonMark spec https://spec.commonmark.org/0.30/. There asterisks and underscore both produce `<em>` elements only in compliant parsers

kerem commented

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

Author

Owner

@DavidAnson commented on GitHub (May 8, 2023):

Agreed. This behavior is not per specification (the plug-in agrees: https://www.npmjs.com/package/markdown-it-underline) and it would be confusing to try to support it for this one isolated case.

@DavidAnson commented on GitHub (May 8, 2023): Agreed. This behavior is not per specification (the plug-in agrees: https://www.npmjs.com/package/markdown-it-underline) and it would be confusing to try to support it for this one isolated case.

kerem commented

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

Author

Owner

@redactedscribe commented on GitHub (May 8, 2023):

I'm not educated enough on the details to argue otherwise so I'll have to agree. I thought it may be common among other parsers etc. Feel free to close if this is clear-cut.

@redactedscribe commented on GitHub (May 8, 2023): I'm not educated enough on the details to argue otherwise so I'll have to agree. I thought it may be common among other parsers etc. Feel free to close if this is clear-cut.

kerem commented

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

Author

Owner

@redactedscribe commented on GitHub (May 9, 2023):

Another thought: Since underlining via underscore would just render as emphasised text in parsers which don't handle underscores vs asterisks differently, with an off option for MD049, we could at least use both styles in VS Code via Markdown Extended without markdownlint complaining, even if the linter won't support underlining specifically.

@redactedscribe commented on GitHub (May 9, 2023): Another thought: Since underlining via underscore would just render as emphasised text in parsers which don't handle underscores vs asterisks differently, with an `off` option for MD049, we could at least use both styles in VS Code via Markdown Extended without markdownlint complaining, even if the linter won't support underlining specifically.

kerem commented

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

Author

Owner

@DavidAnson commented on GitHub (May 9, 2023):

An "off" setting would seem to be the same as disabling the rule. All rules can already be disabled via configuration. (See the README)

@DavidAnson commented on GitHub (May 9, 2023): An "off" setting would seem to be the same as disabling the rule. All rules can already be disabled via configuration. (See the README)

kerem referenced this issue

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

[PR #539] [MERGED] Update MD051/link-fragments to support id attributes on non-a elements. #886

kerem referenced this issue

2026-03-07 20:06:21 +03:00

[GH-ISSUE #538] MD051 should support arbitrary id attributes, not just <a> tags #2287

kerem referenced this issue

2026-03-07 20:10:19 +03:00

[PR #539] [MERGED] Update MD051/link-fragments to support id attributes on non-a elements. #2736