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*
|
|
|
|
```
|
|
|
|
|
|
|
|
The configured emphasis 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.
|