remark-retext

remark-retext

Bridge / mutate from remark to retext.

Installation

npm:

npm install remark-retext

Usage

Say we have the following file, example.md:

## Hello guys!

And our script, example.js, looks as follows:

var vfile = require('to-vfile')
var report = require('vfile-reporter')
var unified = require('unified')
var parse = require('remark-parse')
var stringify = require('remark-stringify')
var remark2retext = require('remark-retext')
var english = require('retext-english')
var equality = require('retext-equality')

unified()
  .use(parse)
  .use(
    remark2retext,
    unified()
      .use(english)
      .use(equality)
  )
  .use(stringify)
  .process(vfile.readSync('example.md'), function(err, file) {
    console.error(report(err || file))
  })

Now, running node example yields:

example.md
  1:10-1:14  warning  `guys` may be insensitive, use `people`, `persons`, `folks` instead  gals-men  retext-equality

⚠ 1 warning

API

origin.use(remark2retext, destination[, options])

Either bridge or mutate from remark (MDAST) to retext (NLCST).

destination

destination is either a parser or a processor.

If a Unified processor is given, runs the destination processor with the new NLCST tree, then, after running discards that tree and continues on running the origin processor with the original tree (bridge-mode).

If a parser (such as parse-latin, parse-english, or parse-dutch) is given, passes the tree to further plug-ins (mutate-mode).

options

Passed to mdast-util-to-nlcst.

Related

• rehype-retext — Transform HTML to NLCST
• remark-rehype — Transform markdown to HTML
• rehype-remark — Transform HTML to markdown
• mdast-util-to-nlcst — Underlying algorithm

Contribute

See contributing.md in remarkjs/remark for ways to get started.

This organisation has a Code of Conduct. By interacting with this repository, organisation, or community you agree to abide by its terms.

License

MIT © Titus Wormer