2021-08-13 22:18:39 -07: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`.
|
|
|
|
|
|
|
|
You can extend the `markdownlint/style/prettier.json` style to disable all
|
|
|
|
markdownlint rules that overlap with Prettier.
|
|
|
|
|
|
|
|
Special situations when not extending `prettier.json` are documented below.
|
2021-08-13 22:18:39 -07:00
|
|
|
|
|
|
|
## 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
|
|
|
|
}
|
|
|
|
}
|
|
|
|
```
|