remark-retext

remark-retext

retext support for remark.

Installation

npm:

npm install remark-retext

remark-retext is also available for duo, and as an AMD, CommonJS, and globals module, uncompressed and compressed.

Usage

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

remark()
    .use(lint)
    .use(remark2retext, retext().use(equality))
    .use(html)
    .process('## Hey guys\n', function (err, file, doc) {
        if (err) {
            throw err;
        } else {
            process.stderr.write(report(file) + '\n');
            process.stdout.write(doc);
        }
    });

Yields:

<stdin>
   1:1-1:12  warning  First heading level should be `1`                                    first-heading-level
   1:8-1:12  warning  `guys` may be insensitive, use `people`, `persons`, `folks` instead

⚠ 2 warnings
<h2>Hey guys</h2>

API

remark.use(remark2retext, retext)

retext support for remark.

Parameters:

• remark2retext — This plug-in;
• retext (Processor).

License

MIT © Titus Wormer