markdownlint/doc/Prettier.md

29 lines
714 B
Markdown
Raw Normal View History

2022-10-06 04:21:08 +00:00
# Using `markdownlint` with Prettier
2022-10-02 01:15:14 -04:00
[`Prettier`](https://prettier.io) is a popular code formatter.
For the most part, Prettier works seamlessly with `markdownlint`.
2022-10-06 04:21:08 +00:00
You can `extend` the [`prettier.json`](../style/prettier.json) style to disable
all `markdownlint` rules that overlap with Prettier.
2022-10-02 01:15:14 -04:00
2022-10-06 04:21:08 +00:00
Other scenarios are documented below.
## List item indentation
The default settings of `markdownlint` and `Prettier` are compatible and don't
result in any linting violations. If `Prettier` is used with `--tab-width` set
to `4`, the following `markdownlint` configuration can be used:
```json
{
"MD007": {
"indent": 4
},
"MD030": {
"ul_single": 3,
"ul_multi": 3,
"ol_multi": 2
}
}
```