rehype-remark

Bridge / mutate from rehype to remark.

Tiny wrapper around hast-util-to-mdast.

Installation

npm:

npm install rehype-remark

Usage

Say our example.js looks as follows:

var unified = require('unified');
var createStream = require('unified-stream');
var parse = require('rehype-parse');
var rehype2remark = require('rehype-remark');
var stringify = require('remark-stringify');

var processor = unified()
  .use(parse)
  .use(rehype2remark)
  .use(stringify);

process.stdin.pipe(createStream(processor)).pipe(process.stdout);

Now, when running the following in a terminal (2>/dev/null is just to silence Curl’s debugging output):

curl https://example.com 2>/dev/null | node example.js

stdout(4) yields:

# Example Domain

This domain is established to be used for illustrative examples in documents. You may use this domain in examples without prior coordination or asking for permission.

[More information...](http://www.iana.org/domains/example)

API

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

Either bridge or mutate from rehype (HAST) to remark (MDAST).

destination

If given (Unified), runs the destination processor with the new MDAST tree, then, after running discards that tree and continues on running the origin processor with the original tree (bridge-mode). Otherwise, passes the tree to further plug-ins (mutate-mode).

options

Options are passed to hast-util-to-mdast. Note that options.document defaults to true in rehype-remark, as this plugin is mostly used with block nodes.

Related

• remark-rehype — Transform markdown to HTML
• rehype-retext — Transform HTML to NLCST
• remark-retext — Transform markdown to NLCST

License

MIT © Titus Wormer