sgauthier
6e64e138e2
4.8 KiB
remark-rehype
remark plugin to bridge or mutate to rehype.
Note:
remark-rehypedoesn’t deal with HTML inside the Markdown. You’ll needrehype-rawif you’re planning on doing that.
Install
npm:
npm install remark-rehype
Use
Say we have the following file, example.md:
# Hello world
> Block quote.
Some _emphasis_, **importance**, and `code`.
And our script, example.js, looks as follows:
var vfile = require('to-vfile')
var report = require('vfile-reporter')
var unified = require('unified')
var markdown = require('remark-parse')
var remark2rehype = require('remark-rehype')
var doc = require('rehype-document')
var format = require('rehype-format')
var html = require('rehype-stringify')
unified()
.use(markdown)
.use(remark2rehype)
.use(doc)
.use(format)
.use(html)
.process(vfile.readSync('example.md'), function(err, file) {
console.error(report(err || file))
console.log(String(file))
})
Now, running node example yields:
example.md: no issues found
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>example</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
</head>
<body>
<h1>Hello world</h1>
<blockquote>
<p>Block quote.</p>
</blockquote>
<p>Some <em>emphasis</em>, <strong>importance</strong>, and <code>code</code>.</p>
</body>
</html>
API
origin.use(remark2rehype[, destination][, options])
remark (mdast) plugin to bridge or mutate to rehype (hast).
destination
If a Unified processor is given, runs the destination processor
with the new hast 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 plugins (mutate mode).
options
Passed to mdast-util-to-hast.
Related
rehype-raw— Properly deal with HTML in Markdown (used afterremark-rehype)rehype-remark— Transform HTML (hast) to Markdown (mdast)rehype-retext— Transform HTML (hast) to natural language (nlcst)remark-retext— Transform Markdown (mdast) to natural language (nlcst)
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, organisation, or community you agree to abide by its terms.