node/tools/eslint/node_modules/remark

remark

The remark processor is a markdown processor powered by plug-ins.

• Interface by unified;
• mdast syntax tree;
• Parses markdown to the tree with remark-parse;
• Plug-ins transform the tree;
• Compiles the tree to markdown using remark-stringify.

Don’t need the parser? Or the compiler? That’s OK.

Installation

npm:

npm install remark

Usage

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

remark().use(lint).use(html).process('## Hello world!', function (err, file) {
    console.error(report(file));
    console.log(file.toString());
});

Yields:

<stdin>
        1:1  warning  Missing newline character at end of file  final-newline
   1:1-1:16  warning  First heading level should be `1`         first-heading-level
   1:1-1:16  warning  Don’t add a trailing `!` to headings      no-heading-punctuation

⚠ 3 warnings
<h2>Hello world!</h2>

License

MIT © Titus Wormer