Skip to content

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

1.  Foo
2.  Bar
3.  Baz

---

4.  Foo2
5.  Bar2
6.  Baz2

After

1.  Foo
1.  Bar
1.  Baz

---

4.  Foo2
4.  Bar2
4.  Baz2

Linking

Broken image

Image URLs should return a correct content type.

Before

![Favicon](https://google.com/)

After

![Favicon](https://www.google.com/favicon.ico)
Configuration
Setting Default value
timeout 6,000
ignored_hosts npmjs.com, www.npmjs.com

Link URLs should return a non-error status code.

Before

[Google](https://googlea.com/)

After

[Google](https://www.google.com/)
Configuration
Setting Default value
timeout 6,000
ignored_hosts npmjs.com, www.npmjs.com

Inline links should be unique. Use reference links for duplicates.

Before

Visit [Google](https://www.google.com).

Don't forget to visit [Google](https://www.google.com).

After

Visit [Google][google].

Don't forget to visit [Google][google].

[google]: https://www.google.com

Styling

Code fence style

md

Backticks style over tilde in code fences.

Before

~~~js
console.log("Hello, world!");
~~~

After

```js
console.log("Hello, world!");
```

Heading style

md

ATX heading style over Setext.

Before

Big headline
============

After

# Big headline

Highlight style

md md

Emphasis and styles use asterisks first. In nested hightlight, use any non-asterisk character as the outer style.

Before

Hello **_World_**

After

Hello __*World*__

Horizontal line style

md

Triple dash style over asterisk and underscore in horizontal lines.

Before

Foo

***

Bar

After

Foo

---

Bar

Table style

md md md

Pipes are present with short column style. Exactly one space padding on each side of cell.

Before

Foo | Bar  | Baz
--- | ---- | ----
Qux | Quux | Quuz

After

| Foo | Bar | Baz |
| --- | --- | --- |
| Qux | Quux | Quuz |

Unordered list style

md

Dash style over asterisk and plus in unordered lists.

Before

* Foo
+ Bar

After

- Foo
- Bar

Spacing

Ordered list spaces

The length of ordered list number and the following space should be even number.

Before

1. Foo
1. Bar
1. Baz

---

10.  Foo2
10.  Bar2
10.  Baz2

After

1.  Foo
1.  Bar
1.  Baz

---

10. Foo2
10. Bar2
10. Baz2

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

- Foo

- Bar

- Baz

After

- Foo
- Bar
- Baz