Skip to content

Latest commit

 

History

History
32 lines (21 loc) · 776 Bytes

md049.md

File metadata and controls

32 lines (21 loc) · 776 Bytes
Raw

MD049 - Emphasis style should be consistent

Tags: emphasis

Aliases: emphasis-style

Parameters:

  • style: Emphasis style should be consistent (string, default consistent, values asterisk / consistent / underscore)

Fixable: Some violations can be fixed by tooling

This rule is triggered when the symbols used in the document for emphasis do not match the configured emphasis style:

*Text*
_Text_

To fix this issue, use the configured emphasis style throughout the document:

*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.

Rationale: Consistent formatting makes it easier to understand a document.