Skip to content

Commit 383e3cd

Browse files
committed
Add docs for handlers
1 parent 1294628 commit 383e3cd

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,15 @@ Yields:
3434

3535
## API
3636

37-
### `toMDAST(node)`
37+
### `toMDAST(node[, options])`
3838

3939
Transform the given [HAST][] tree to an [MDAST][] tree.
4040

41+
###### `options.handlers`
42+
43+
* Object mapping tag-names to functions handling those elements.
44+
Take a look at [`handlers/`][handlers] for examples.
45+
4146
## Related
4247

4348
* [`mdast-util-to-hast`][mdast-util-to-hast]
@@ -69,3 +74,5 @@ Transform the given [HAST][] tree to an [MDAST][] tree.
6974
[mdast-util-to-hast]: https://github.com/syntax-tree/mdast-util-to-hast
7075

7176
[3]: https://github.com/syntax-tree/hast-util-to-mdast/issues/3
77+
78+
[handlers]: https://github.com/syntax-tree/hast-util-to-mdast/tree/master/handlers

0 commit comments

Comments
 (0)