This package provides netzkern .remarkrc as an extensible shared config.
- Extends
remark-preset-lint-recommended
. - Extends
remark-preset-lint-consistent
.
remark-lint is a markdown code style linter. Another linter? Yes. Ensuring the markdown you (and contributors) write is of great quality will provide better rendering in all the different markdown parsers, and makes sure less refactoring is needed afterwards.
npm:
npm install remark-config-netzkern --save
You probably want to use it on the CLI through a config file:
...
"remarkConfig": {
+ "plugins": ["preset-lint-netzkern"]
}
...
Or use it on the CLI directly
remark -u preset-lint-netzkern readme.md
Or use this on the API:
var remark = require('remark');
var report = require('vfile-reporter');
remark()
+ .use(require('remark-preset-lint-netzkern'))
.process('_Emphasis_ and **importance**', function (err, file) {
console.error(report(err || file));
});
rules lists all available official rules.