Markdown rules
Ordered list number¶
Use lazy numbering in ordered lists. The prefix may start with any number, but the rest should follow the first one.
Before
After
Linking¶
Broken image¶
Image URLs should return a correct content type.
Before
After
Configuration
| Setting | Default value |
|---|---|
timeout |
6,000 |
ignored_hosts |
npmjs.com, www.npmjs.com |
Dead link¶
Link URLs should return a non-error status code.
Before
After
Configuration
| Setting | Default value |
|---|---|
timeout |
6,000 |
ignored_hosts |
npmjs.com, www.npmjs.com |
Duplicate link¶
Inline links should be unique. Use reference links for duplicates.
Before
After
Styling¶
Code fence style¶
Backticks style over tilde in code fences.
Before
After
Heading style¶
ATX heading style over Setext.
Before
After
Highlight style¶
Emphasis and styles use asterisks first. In nested hightlight, use any non-asterisk character as the outer style.
Before
After
Horizontal line style¶
Triple dash style over asterisk and underscore in horizontal lines.
Before
After
Table style¶
Pipes are present with short column style. Exactly one space padding on each side of cell.
Before
After
Unordered list style¶
Dash style over asterisk and plus in unordered lists.
Before
After
Spacing¶
Ordered list spaces¶
The length of ordered list number and the following space should be even number.
Before
After
Trimming¶
Unnecessary blank lines in list¶
If no list item is expanded with a paragraph, remove blank lines between them. A blank line between one list item and a nested list is not checked.
Before
After