From d160fadf96bf403748096dd2a6833e3b4e24cf8d Mon Sep 17 00:00:00 2001 From: Titus Wormer Date: Thu, 23 Feb 2017 11:25:10 +0100 Subject: [PATCH] Add docs for `options` --- readme.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/readme.md b/readme.md index 230acbd..21b5afd 100644 --- a/readme.md +++ b/readme.md @@ -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][]). @@ -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]