sgauthier
6e64e138e2
All checks were successful
Publish To Prod / deploy_and_publish (push) Successful in 35s
175 lines
4.9 KiB
Markdown
175 lines
4.9 KiB
Markdown
# rehype-remark
|
||
|
||
[![Build][build-badge]][build]
|
||
[![Coverage][coverage-badge]][coverage]
|
||
[![Downloads][downloads-badge]][downloads]
|
||
[![Size][size-badge]][size]
|
||
[![Sponsors][sponsors-badge]][collective]
|
||
[![Backers][backers-badge]][collective]
|
||
[![Chat][chat-badge]][chat]
|
||
|
||
[**rehype**][rehype] plugin to bridge or mutate to [**remark**][remark].
|
||
|
||
Tiny wrapper around [`hast-util-to-mdast`][to-mdast].
|
||
|
||
## Note!
|
||
|
||
This plugin is ready for the new parser in remark
|
||
([`remarkjs/remark#536`](https://github.com/remarkjs/remark/pull/536)).
|
||
No change is needed: it works exactly the same now as it did before!
|
||
|
||
## Install
|
||
|
||
[npm][]:
|
||
|
||
```sh
|
||
npm install rehype-remark
|
||
```
|
||
|
||
## Use
|
||
|
||
Say our `example.js` looks as follows:
|
||
|
||
```js
|
||
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):
|
||
|
||
```sh
|
||
curl https://example.com 2>/dev/null | node example.js
|
||
```
|
||
|
||
**stdout**(4) yields:
|
||
|
||
```markdown
|
||
# Example Domain
|
||
|
||
This domain is for use in illustrative examples in documents. You may use this domain in literature without prior coordination or asking for permission.
|
||
|
||
[More information...](https://www.iana.org/domains/example)
|
||
```
|
||
|
||
## API
|
||
|
||
### `origin.use(rehype2remark[, destination][, options])`
|
||
|
||
[**rehype**][rehype] ([hast][]) plugin to bridge or mutate to
|
||
[**remark**][remark] ([mdast][]).
|
||
|
||
###### `destination`
|
||
|
||
If given ([`Unified`][processor]), 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 **hast** tree ([bridge-mode][bridge]).
|
||
Otherwise, passes the tree to further plugins (mutate-mode).
|
||
|
||
###### `options`
|
||
|
||
Options are passed to [`hast-util-to-mdast`][to-mdast].
|
||
Note that [`options.document`][document] defaults to `true` in `rehype-remark`,
|
||
as this plugin is mostly used with blocks.
|
||
|
||
## Security
|
||
|
||
Use of `rehype-remark` can open you up to a [cross-site scripting (XSS)][xss]
|
||
attack if the tree is unsafe.
|
||
Use [`rehype-sanitize`][sanitize] to make the tree safe.
|
||
|
||
## Related
|
||
|
||
* [`remark-rehype`](https://github.com/remarkjs/remark-rehype)
|
||
— Transform Markdown ([**mdast**][mdast]) to HTML ([**hast**][hast])
|
||
* [`rehype-retext`](https://github.com/rehypejs/rehype-retext)
|
||
— Transform HTML ([**hast**][hast]) to natural language ([**nlcst**][nlcst])
|
||
* [`remark-retext`](https://github.com/remarkjs/remark-retext)
|
||
— Transform Markdown ([**mdast**][mdast]) to natural language
|
||
([**nlcst**][nlcst])
|
||
|
||
## Contribute
|
||
|
||
See [`contributing.md`][contributing] in [`rehypejs/.github`][health] for ways
|
||
to get started.
|
||
See [`support.md`][support] for ways to get help.
|
||
|
||
This project has a [code of conduct][coc].
|
||
By interacting with this repository, organization, or community you agree to
|
||
abide by its terms.
|
||
|
||
## License
|
||
|
||
[MIT][license] © [Titus Wormer][author]
|
||
|
||
<!-- Definitions -->
|
||
|
||
[build-badge]: https://github.com/rehypejs/rehype-remark/workflows/main/badge.svg
|
||
|
||
[build]: https://github.com/rehypejs/rehype-remark/actions
|
||
|
||
[coverage-badge]: https://img.shields.io/codecov/c/github/rehypejs/rehype-remark.svg
|
||
|
||
[coverage]: https://codecov.io/github/rehypejs/rehype-remark
|
||
|
||
[downloads-badge]: https://img.shields.io/npm/dm/rehype-remark.svg
|
||
|
||
[downloads]: https://www.npmjs.com/package/rehype-remark
|
||
|
||
[size-badge]: https://img.shields.io/bundlephobia/minzip/rehype-remark.svg
|
||
|
||
[size]: https://bundlephobia.com/result?p=rehype-remark
|
||
|
||
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
|
||
|
||
[backers-badge]: https://opencollective.com/unified/backers/badge.svg
|
||
|
||
[collective]: https://opencollective.com/unified
|
||
|
||
[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg
|
||
|
||
[chat]: https://github.com/rehypejs/rehype/discussions
|
||
|
||
[npm]: https://docs.npmjs.com/cli/install
|
||
|
||
[health]: https://github.com/rehypejs/.github
|
||
|
||
[contributing]: https://github.com/rehypejs/.github/blob/HEAD/contributing.md
|
||
|
||
[support]: https://github.com/rehypejs/.github/blob/HEAD/support.md
|
||
|
||
[coc]: https://github.com/rehypejs/.github/blob/HEAD/code-of-conduct.md
|
||
|
||
[license]: license
|
||
|
||
[author]: https://wooorm.com
|
||
|
||
[remark]: https://github.com/remarkjs/remark
|
||
|
||
[rehype]: https://github.com/rehypejs/rehype
|
||
|
||
[mdast]: https://github.com/syntax-tree/mdast
|
||
|
||
[hast]: https://github.com/syntax-tree/hast
|
||
|
||
[nlcst]: https://github.com/syntax-tree/nlcst
|
||
|
||
[processor]: https://github.com/unifiedjs/unified#processor
|
||
|
||
[bridge]: https://github.com/unifiedjs/unified#processing-between-syntaxes
|
||
|
||
[to-mdast]: https://github.com/syntax-tree/hast-util-to-mdast
|
||
|
||
[document]: https://github.com/syntax-tree/hast-util-to-mdast#optionsdocument
|
||
|
||
[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting
|
||
|
||
[sanitize]: https://github.com/rehypejs/rehype-sanitize
|