2023-10-25 20:05:19 -07:00
|
|
|
# `MD050` - Strong style
|
2022-10-29 23:21:45 -07:00
|
|
|
|
2022-10-30 15:13:19 -07:00
|
|
|
Tags: `emphasis`
|
2022-10-29 23:21:45 -07:00
|
|
|
|
2022-10-30 15:13:19 -07:00
|
|
|
Aliases: `strong-style`
|
2022-10-29 23:21:45 -07:00
|
|
|
|
|
|
|
|
Parameters:
|
|
|
|
|
|
2023-07-29 15:20:10 -07:00
|
|
|
- `style`: Strong style (`string`, default `consistent`, values `asterisk` /
|
|
|
|
|
`consistent` / `underscore`)
|
2022-10-29 23:21:45 -07:00
|
|
|
|
2022-12-16 13:53:03 -08:00
|
|
|
Fixable: Some violations can be fixed by tooling
|
2022-10-29 23:21:45 -07:00
|
|
|
|
|
|
|
|
This rule is triggered when the symbols used in the document for strong do not
|
|
|
|
|
match the configured strong style:
|
|
|
|
|
|
|
|
|
|
```markdown
|
|
|
|
|
**Text**
|
|
|
|
|
__Text__
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
To fix this issue, use the configured strong style throughout the document:
|
|
|
|
|
|
|
|
|
|
```markdown
|
|
|
|
|
**Text**
|
|
|
|
|
**Text**
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
The configured strong style can be a specific symbol to use ("asterisk",
|
|
|
|
|
"underscore"), or can require that usage be consistent within the document.
|
|
|
|
|
|
2024-02-19 15:41:10 -08:00
|
|
|
Note: Emphasis within a word is restricted to "asterisk" in order to avoid
|
|
|
|
|
unwanted emphasis for words containing internal underscores like_this_one.
|
|
|
|
|
|
2022-10-29 23:21:45 -07:00
|
|
|
Rationale: Consistent formatting makes it easier to understand a document.
|
