Emphasis
Key Point
💡 How to use emphasis to highlight text
Italic
Use one (1) asterisk *
marker to generate spans for italic formatted text.
remark-lint: emphasis-marker
👍 Correct code for this rule:
*Winter*
*Snow*
👎 Incorrect code for this rule:
__Winter__
__Snow__
Bold
Use two (2) asterisk *
marker to generate spans for bold formatted text.
remark-lint: emphasis-marker and strong-marker
👍 Correct code for this rule:
**Winter**
**Snow**
👎 Incorrect code for this rule:
*Winter*
No header replacement
Do not use emphasis elements (bold or italics) to introduce a multi line named section. Use headers instead which is exactly the semantic meaning of headers.
As a consequence, many implementations add useful behaviors to headers and not to emphasis elements, such as automatic ID generation (anchor) to make it easier to refer to the header later on.
Use a level 6 header if the meaning of the header section should not stand out great.
remark-lint: no-emphasis-as-heading
👍 Correct code for this rule:
## Winter
The winter has sparkling and frozen elements!
## Snow
Snow is falling down!
###### Winter
The winter has sparkling and frozen elements!
###### Snow
Snow is falling down!
👎 Incorrect code for this rule:
**Winter**
The winter has sparkling and frozen elements!
__Snow__
Snow is falling down!
No inner spacing
Do not use inner spaces for any markers.
remark-lint: no-inline-padding
👍 Correct code for this rule:
**Winter**
*Snow*
👎 Incorrect code for this rule:
** Winter **
* Snow *
** Winter **
* Snow *