remark-lint/packages/remark-preset-lint-consistent/readme.md

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

Use

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))
   })

Contribute

See contributing.md in remarkjs/.github for ways to get started. See support.md for ways to get help.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MIT © Titus Wormer