mirror of
https://github.com/remarkjs/remark-lint.git
synced 2024-10-27 03:37:50 +03:00
282d27606d
This commit rewrites most of the documentation per rule and preset, `remark-lint` itself, and `unified-lint-rule`. * Better and more readable automatic examples * Check and update all rule descriptions * Use middot (·) and line-feed (␊) for relevant examples * Unify descriptions of `'consistent`' * Add some more docs where needed Closes GH-158.
2.6 KiB
2.6 KiB
remark-preset-lint-consistent
remark preset to configure remark-lint with settings that enforce consistency.
Rules
This preset configures remark-lint with the following rules:
| Rule | Setting |
|---|---|
blockquote-indentation |
'consistent' |
checkbox-character-style |
'consistent' |
code-block-style |
'consistent' |
emphasis-marker |
'consistent' |
fenced-code-marker |
'consistent' |
heading-style |
'consistent' |
link-title-style |
'consistent' |
list-item-content-indent |
|
ordered-list-marker-style |
'consistent' |
rule-style |
'consistent' |
strong-marker |
'consistent' |
table-cell-padding |
'consistent' |
Install
npm:
npm install remark-preset-lint-consistent
Usage
You probably want to use it on the CLI through a config file:
...
"remarkConfig": {
+ "plugins": ["preset-lint-consistent"]
}
...
Or use it on the CLI directly
remark -u preset-lint-consistent readme.md
Or use this on the API:
var remark = require('remark');
var report = require('vfile-reporter');
remark()
+ .use(require('remark-preset-lint-consistent'))
.process('_Emphasis_ and **importance**', function (err, file) {
console.error(report(err || file));
});