Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add Prettier.md to document compatibility issues (fixes #410).
- Loading branch information
1 parent
92111e0
commit 580e57d
Showing
3 changed files
with
29 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# Using markdownlint with Prettier | ||
|
||
[`Prettier`](https://prettier.io) is a popular code formatter. For the most part, | ||
it works seamlessly with `markdownlint`. Special situations 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 | ||
} | ||
} | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters