@@ -31,32 +31,10 @@ To install the tool and use it globally run:
31
31
npm install -g @343dev/markdown-lint
32
32
```
33
33
34
- To install the tool into the project and setup pre-commit hook run :
34
+ To install the tool into the project:
35
35
36
36
``` bash
37
- npm install --dev husky lint-staged @343dev/markdown-lint
38
- ```
39
-
40
- ## Project Setup
41
-
42
- To automatically lint Markdown files on precommit you should setup ` husky ` and
43
- ` lint-staged ` to work with ` markdown-lint ` in your project’s package.json.
44
-
45
- Example:
46
-
47
- ``` json
48
- {
49
- "husky" : {
50
- "hooks" : {
51
- "pre-commit" : " lint-staged"
52
- }
53
- },
54
- "lint-staged" : {
55
- "*.md" : [
56
- " markdown-lint --fix --typograph"
57
- ]
58
- }
59
- }
37
+ npm install --dev @343dev/markdown-lint
60
38
```
61
39
62
40
## CLI Usage
@@ -120,13 +98,13 @@ module.exports = {
120
98
// plugins for remark-lint
121
99
plugins: [
122
100
// print errors when there're lines longer that 120 characters
123
- [require ( ' remark-lint-maximum-line-length' ) , 120 ],
101
+ [' remark-lint-maximum-line-length' , 120 ],
124
102
125
103
// disable rule `no-inline-padding`
126
- [require ( ' remark-lint-no-inline-padding' ) , false ],
104
+ [' remark-lint-no-inline-padding' , false ],
127
105
128
106
// set `*` as the only allowed marker for unordered list
129
- [require ( ' remark-lint-unordered-list-marker-style' ) , ' *' ]
107
+ [' remark-lint-unordered-list-marker-style' , ' *' ]
130
108
],
131
109
132
110
// settings for remark-stringify which is used when `--fix` is passed
@@ -138,7 +116,7 @@ module.exports = {
138
116
139
117
typograf: {
140
118
// rules API — https://github.com/typograf/typograf/blob/dev/docs/api_rules.md
141
- // list of ruls — https://github.com/typograf/typograf/blob/dev/docs/RULES.en-US.md
119
+ // list of rules — https://github.com/typograf/typograf/blob/dev/docs/RULES.en-US.md
142
120
locale: [' ru' , ' en-US' ],
143
121
enableRules: [],
144
122
disableRules: [
0 commit comments