doc: Update API document.

jaywcjlove · Apr 25, 2022 · 6e50f05 · 6e50f05
1 parent 226cd10
commit 6e50f05
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 2 deletions.
diff --git a/packages/html-to-markdown/README.md b/packages/html-to-markdown/README.md
@@ -44,11 +44,22 @@ htmlToMarkdown({ html: '<h1>Markdown String</h1>' });
 ## API
 
 ```ts
+import { PluggableList } from 'unified';
 import { Options as RehypeParseOptions } from 'rehype-parse';
 declare type Options = {
   html?: string;
   url?: string;
   rehypeParseOption?: RehypeParseOptions;
+  /**
+   * List of [remark plugins](https://github.com/remarkjs/remark/blob/main/doc/plugins.md#list-of-plugins) to use.
+   * See the next section for examples on how to pass options
+   */
+  remarkPlugins?: PluggableList;
+  /**
+   * List of [rehype plugins](https://github.com/rehypejs/rehype/blob/main/doc/plugins.md#list-of-plugins) to use.
+   * See the next section for examples on how to pass options
+   */
+  rehypePlugins?: PluggableList;
 };
 export default function htmlToMarkdown(options?: Options): Promise<string>;
 ```

diff --git a/packages/html-to-markdown/src/index.ts b/packages/html-to-markdown/src/index.ts
@@ -11,9 +11,15 @@ type Options = {
   html?: string
   url?: string
   rehypeParseOption?: RehypeParseOptions;
-  /** List of [remark plugins](https://github.com/remarkjs/remark/blob/main/doc/plugins.md#list-of-plugins) to use. See the next section for examples on how to pass options */
+  /**
+   * List of [remark plugins](https://github.com/remarkjs/remark/blob/main/doc/plugins.md#list-of-plugins) to use.
+   * See the next section for examples on how to pass options
+   */
   remarkPlugins?: PluggableList;
-  /** List of [rehype plugins](https://github.com/rehypejs/rehype/blob/main/doc/plugins.md#list-of-plugins) to use. See the next section for examples on how to pass options */
+  /**
+   * List of [rehype plugins](https://github.com/rehypejs/rehype/blob/main/doc/plugins.md#list-of-plugins) to use.
+   * See the next section for examples on how to pass options
+   */
   rehypePlugins?: PluggableList;
 }