Use one (1) underscore _
marker to generate spans for italic formatted text.
remark-lint: emphasis-marker
⇣ Incorrect code for this rule:
*Winter*
___Snow___
⇡ Correct code for this rule:
_Winter_
_Snow_
Use two (2) asterisk *
marker to generate spans for bold formatted text.
remark-lint: emphasis-marker and strong-marker
⇣ Incorrect code for this rule:
*Winter*
***Snow***
⇡ Correct code for this rule:
**Winter**
**Snow**
Note that strikethrough is an extension of GFM and not implemented by all parsers!
Use two (2) tilde ~
marker to generate spans for strikethrough text.
remark-lint: strikethrough-marker, emphasis-marker
⇣ Incorrect code for this rule:
~Winter~
~~~Snow~~~
⇡ Correct code for this rule:
~~Winter~~
~~Snow~~
Don't 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
⇣ Incorrect code for this rule:
**Winter**
The winter has sparkling and frozen elements!
__Snow__
Snow is falling down!
⇡ 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!
Don't use inner spaces for any markers.
remark-lint: no-inline-padding
⇣ Incorrect code for this rule:
** Winter **
__ Snow __
** Winter **
__ Snow __
⇡ Correct code for this rule:
**Winter**
**Snow**