@@ -96,10 +96,9 @@ An example `.remarkrc` file could look as follows:
9696{
9797  "plugins" : {
9898    "lint" : {
99-         "no-multiple-toplevel-headings" : false ,
100-         "maximum-line-length" : 79 ,
101-         "emphasis-marker" : " _"  ,
102-         "strong-marker" : " *" 
99+       "no-multiple-toplevel-headings" : false ,
100+       "list-item-indent" : false ,
101+       "maximum-line-length" : 79 
103102    }
104103  },
105104  "settings" : {
@@ -108,10 +107,32 @@ An example `.remarkrc` file could look as follows:
108107}
109108``` 
110109
111- Where the object at ` plugins.lint `  is a map of ` ruleId ` s and their values.
112- The object at ` settings `  determines how ** remark**  parses (and compiles)
113- markdown code.  Read more about the latter on [ ** remark** ’s
114- readme] [ remark-process ] .
110+ Where the object at ` plugins.lint `  is a map of ` ruleId ` s and their values. The
111+ object at ` settings `  determines how ** remark**  parses (and compiles)
112+ markdown code. Read more about the latter on
113+ [ ** remark** ’s readme] [ remark-process ] .
114+ 
115+ Using our ` example.md `  from before:
116+ 
117+ ``` md 
118+ * Hello
119+ 
120+ [World][]
121+ ``` 
122+ 
123+ We now run the below command _ without_  the ` -u remark-lint `  since
124+ our ` .remarkrc `  includes the lint plugin.
125+ 
126+ ``` bash 
127+ remark example.md
128+ # 
129+ #  Yields:
130+ # 
131+ #  example.md
132+ #     3:1-3:10  warning  Found reference to undefined definition   no-undefined-references
133+ # 
134+ #  ⚠ 2 warnings
135+ ``` 
115136
116137In addition, you can also provide configuration comments to turn a rule
117138on or off inside a file. Note that you cannot change what a setting,
0 commit comments