Skip to content

Commit d080c31

Browse files
committed
Add better docs
1 parent e431f6f commit d080c31

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

readme.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@
1010

1111
**[mdast][]** utility to parse markdown.
1212

13+
## When to use this
14+
15+
Use this if you have direct access to an AST and need to serialize it.
16+
Use **[remark][]** instead, which includes this, but has a nice interface and
17+
hundreds of plugins.
18+
1319
## Install
1420

1521
This package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c):
@@ -317,3 +323,5 @@ abide by its terms.
317323
[handlers]: lib/handle
318324

319325
[unsafe]: lib/unsafe.js
326+
327+
[remark]: https://github.com/remarkjs/remark

0 commit comments

Comments
 (0)