Skip to content

Commit

Permalink
Add docs for options
Browse files Browse the repository at this point in the history
  • Loading branch information
wooorm committed Feb 23, 2017
1 parent 1c653e5 commit d160fad
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ This domain is established to be used for illustrative examples in documents. Yo

## API

### `origin.use(rehype2remark[, destination])`
### `origin.use(rehype2remark[, destination][, options])`

Either bridge or mutate from [**rehype**][rehype] ([HAST][]) to
[**remark**][remark] ([MDAST][]).
Expand All @@ -62,6 +62,10 @@ continues on running the origin processor with the original tree
([bridge-mode][bridge]). Otherwise, passes the tree to further
plug-ins (mutate-mode).

###### `options`

Options are passed to [`hdast-util-to-mdast`][to-mdast].

## License

[MIT][license] © [Titus Wormer][author]
Expand Down

0 comments on commit d160fad

Please sign in to comment.