Skip to content

Commit 9fc1a20

Browse files
committed
Add note
1 parent 3f1c7d6 commit 9fc1a20

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

readme.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
Transform [MDAST][] to [HAST][].
44

5+
> **Note** You probably want to use [remark-rehype][].
6+
57
## Installation
68

79
[npm][]:
@@ -51,7 +53,7 @@ are found. The default behaviour is to prefer the last duplicate definition.
5153

5254
###### `options.handlers`
5355

54-
Object mapping [MDAST nodes][mdast] to functions
56+
Object mapping [MDAST nodes][mdast] to functions
5557
handling those elements.
5658
Take a look at [`lib/handlers/`][handlers] for examples.
5759

@@ -108,3 +110,5 @@ Take a look at [`lib/handlers/`][handlers] for examples.
108110
[hast-util-sanitize]: https://github.com/syntax-tree/hast-util-sanitize
109111

110112
[handlers]: lib/handlers
113+
114+
[remark-rehype]: https://github.com/wooorm/remark-rehype

0 commit comments

Comments
 (0)