Skip to content

Commit 3f04513

Browse files
committed
Add docs on extensions
1 parent 277bf12 commit 3f04513

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

readme.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Now, running `node example` yields (positional info removed for brevity):
6363

6464
## API
6565

66-
### `fromMarkdown(doc[, encoding])`
66+
### `fromMarkdown(doc[, encoding][, options])`
6767

6868
Parse markdown to a **[mdast][]** tree.
6969

@@ -78,6 +78,10 @@ Value to parse (`string` or [`Buffer`][buffer]).
7878
[Character encoding][encoding] to understand `doc` as when it’s a
7979
[`Buffer`][buffer] (`string`, default: `'utf8'`).
8080

81+
###### `options.mdastExtensions`
82+
83+
Array of mdast extensions (`Array.<MdastExtension>`, default: `[]`).
84+
8185
##### Returns
8286

8387
[`Root`][root].

0 commit comments

Comments
 (0)