MD050 - strong-style¶
Description¶
This rule is triggered when the symbols used in the document for strong/bold text do not match the configured style. Markdown supports both double asterisks (**text**) and double underscores (__text__) for strong emphasis.
Rationale¶
Consistent formatting makes it easier to understand a document. Using the same strong emphasis style throughout a document improves readability.
Configuration¶
style-
Required strong/bold style.
- Default:
consistent - Options:
consistent: All strong markers must match the first one usedasterisk: All strong markers must use**underscore: All strong markers must use__
- Default:
Examples¶
Invalid¶
# Inconsistent Strong Style
This text uses **asterisks** for bold.
But this uses __underscores__ for bold.
Valid¶
# Consistent Strong Style
This text uses **asterisks** for bold.
Another **bold word** in the document.
Multiple **bold** words on the **same** line.