Skip to content

Commit 1a63533

Browse files
committed
Add reference to rehype in readme.md
1 parent b64b571 commit 1a63533

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

readme.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
Compile markdown to HTML with [**remark**][remark].
44

5+
> :warning: This package essentially packs [`remark-rehype`][remark2rehype] and
6+
> [`rehype-stringify`][rehype-stringify], and although it does support some
7+
> customisation, it isn’t very pluggable. It’s probably smarter to use
8+
> `remark-rehype` directly and benefit from the [**rehype**][rehype]
9+
> ecosystem.
10+
511
## Installation
612

713
[npm][]:
@@ -195,3 +201,9 @@ For example, the following node:
195201
[github]: https://github.com/wooorm/hast-util-sanitize#schema
196202

197203
[to-hast]: https://github.com/wooorm/mdast-util-to-hast#note
204+
205+
[remark2rehype]: https://github.com/wooorm/remark-rehype
206+
207+
[rehype-stringify]: https://github.com/wooorm/rehype/tree/master/packages/rehype-stringify
208+
209+
[rehype]: https://github.com/wooorm/rehype

0 commit comments

Comments
 (0)