Skip to content
Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
index.js
package.json Publish a patch version for all packages Jun 20, 2019
readme.md Add badges, contributing, etc to packages Jun 20, 2019

readme.md

remark-preset-lint-recommended

Build Coverage Downloads Size Sponsors Backers Chat

remark preset to configure remark-lint with settings that prevent mistakes or syntaxes that do not work correctly across vendors.

Rules

This preset configures remark-lint with the following rules:

Rule Setting
final-newline
list-item-bullet-indent
list-item-indent 'tab-size'
no-auto-link-without-protocol
no-blockquote-without-marker
no-literal-urls
ordered-list-marker-style '.'
hard-break-spaces
no-duplicate-definitions
no-heading-content-indent
no-inline-padding
no-shortcut-reference-image
no-shortcut-reference-link
no-undefined-references
no-unused-definitions

Install

npm:

npm install remark-preset-lint-recommended

Use

You probably want to use it on the CLI through a config file:

 ...
 "remarkConfig": {
+  "plugins": ["preset-lint-recommended"]
 }
 ...

Or use it on the CLI directly

remark -u preset-lint-recommended readme.md

Or use this on the API:

 var remark = require('remark');
 var report = require('vfile-reporter');

 remark()
+  .use(require('remark-preset-lint-recommended'))
   .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, organisation, or community you agree to abide by its terms.

License

MIT © Titus Wormer

You can’t perform that action at this time.