Skip to content

Commit ffb41ee

Browse files
committed
docs: update
1 parent 7483637 commit ffb41ee

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88

99
Enhance [`markdown-it`](https://github.com/markdown-it/markdown-it) to support **async** highlight function.
1010

11+
This package is a wrapper on top of `markdown-it` instead of a fork. Updates from `markdown-it` will be reflected without as transient dependencies.
12+
1113
## Usage
1214

1315
```ts
@@ -20,6 +22,7 @@ const md = MarkdownItAsync({
2022
}
2123
})
2224

25+
// Note you need to use `renderAsync` instead of `render`
2326
const html = await md.renderAsync(markdown)
2427
```
2528

0 commit comments

Comments
 (0)