2023-10-25 20:05:19 -07:00
|
|
|
# `MD049` - Emphasis 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: `emphasis-style`
|
2022-10-29 23:21:45 -07:00
|
|
|
|
|
|
|
|
Parameters:
|
|
|
|
|
|
2023-07-29 15:20:10 -07:00
|
|
|
- `style`: Emphasis 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 emphasis do not
|
|
|
|
|
match the configured emphasis style:
|
|
|
|
|
|
|
|
|
|
```markdown
|
|
|
|
|
*Text*
|
|
|
|
|
_Text_
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
To fix this issue, use the configured emphasis style throughout the document:
|
|
|
|
|
|
|
|
|
|
```markdown
|
|
|
|
|
*Text*
|
|
|
|
|
*Text*
|
|
|
|
|
```
|
|
|
|
|
|
2024-10-07 22:08:16 -07:00
|
|
|
The configured emphasis style can be a specific symbol to use (`asterisk`,
|
|
|
|
|
`underscore`) or can require all emphasis matches the first emphasis
|
|
|
|
|
(`consistent`).
|
2022-10-29 23:21:45 -07:00
|
|
|
|
2024-10-07 22:08:16 -07:00
|
|
|
Note: Emphasis within a word is restricted to `asterisk` in order to avoid
|
2024-02-19 15:41:10 -08:00
|
|
|
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.
|
