remark-retext

remark plugin to bridge or mutate to retext.

Install

npm install remark-retext

Use

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])`

remark (mdast) plugin to bridge or mutate 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 plugins (mutate mode).

`options`

Passed to mdast-util-to-nlcst.

Security

Use of remark-retext does not involve rehype (hast) or user content so there are no openings for cross-site scripting (XSS) attacks.

rehype-retext — Transform HTML (hast) to natural language (nlcst)
remark-rehype — Transform Markdown (mdast) to HTML (hast)
rehype-remark — Transform HTML (hast) to Markdown (mdast)
mdast-util-to-nlcst — Underlying algorithm

Contribute

See contributing.md in remarkjs/.github for ways to get started. See support.md for ways to get help.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

License

Current Tags

4.0.0 ... latest (6 years ago)

3 Versions

5.0.1 ... 4 years ago
4.0.0 ... 6 years ago
3.1.3 ... 6 years ago