Skip to content

remark preset to configure remark-lint with settings that enforce standard-readme.

License

Notifications You must be signed in to change notification settings

RichardLitt/standard-readme-preset

Repository files navigation

standard-readme-preset

Greenkeeper badge

remark preset to configure remark-lint with settings that enforce standard-readme.

Install

npm:

npm install standard-readme-preset

Dependencies

Usage

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

 ...
 "remarkConfig": {
+  "plugins": ["standard-readme-preset"]
 }
 ...

Or use it on the CLI directly

remark -u standard-readme-preset README.md

Or use this on the API:

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

 remark()
+  .use(require('standard-readme-preset'))
   .process('_Emphasis_ and **importance**', function (err, file) {
     console.error(report(err || file));
   });

Rules

This preset configures remark-lint with the following rules:

Contributing

Please do! Open an issue!

License

ISC © Richard Littauer

About

remark preset to configure remark-lint with settings that enforce standard-readme.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published