Merge pull request #2 from ChristianMurphy/types/apply-partial-to-rehype-react

types: apply partial to rehype react options

Author: ChristianMurphy

.github/workflows/gh-page.yml

@@ -2,7 +2,7 @@ name: Deploy to GitHub pages
 
 on:
   push:
-    branches: [master]
+    branches: [main]
 
 jobs:
   build-and-deploy:

.github/workflows/main.yml

@@ -2,9 +2,9 @@ name: CI
 
 on:
   push:
-    branches: [master]
+    branches: [main]
   pull_request:
-    branches: [master]
+    branches: [main]
 
 jobs:
   build:

readme.md

@@ -1,6 +1,6 @@
 # react-remark
 
-[![CI](https://github.com/ChristianMurphy/react-remark/workflows/CI/badge.svg?branch=master)](https://github.com/ChristianMurphy/react-remark/actions?query=workflow%3ACI)
+[![CI](https://github.com/ChristianMurphy/react-remark/workflows/CI/badge.svg?branch=main)](https://github.com/ChristianMurphy/react-remark/actions?query=workflow%3ACI)
 
 **react-remark** offers a [React hook](https://reactjs.org/docs/hooks-intro.html) and [React component](https://reactjs.org/docs/glossary.html#components) based way of rendering [markdown](https://commonmark.org/) into [React](https://reactjs.org) using [remark](https://github.com/remarkjs/remark)
 
@@ -129,14 +129,14 @@ The source for the story files can be found in [_/stories_](./stories).
 +---------------------------------------------------------------------------------------------------------------------------------------------+
 ```
 
-relevant links: [markdown](https://commonmark.org), [remark](https://github.com/remarkjs/remark), [mdast](https://github.com/syntax-tree/mdast), [remark plugins](https://github.com/remarkjs/remark/blob/master/doc/plugins.md), [remark-rehype](https://github.com/remarkjs/remark-rehype), [hast](https://github.com/syntax-tree/hast), [rehype plugins](https://github.com/rehypejs/rehype/blob/master/doc/plugins.md), [rehype-react](https://github.com/rehypejs/rehype-react)
+relevant links: [markdown](https://commonmark.org), [remark](https://github.com/remarkjs/remark), [mdast](https://github.com/syntax-tree/mdast), [remark plugins](https://github.com/remarkjs/remark/blob/main/doc/plugins.md), [remark-rehype](https://github.com/remarkjs/remark-rehype), [hast](https://github.com/syntax-tree/hast), [rehype plugins](https://github.com/rehypejs/rehype/blob/main/doc/plugins.md), [rehype-react](https://github.com/rehypejs/rehype-react)
 
 ## Options
 
-- `remarkParseOptions` (Object) - configure how Markdown is parsed, same as [`remark-parse` options](https://github.com/remarkjs/remark/tree/master/packages/remark-parse#options)
-- `remarkPlugins` (Array) - [remark plugins](https://github.com/remarkjs/remark/blob/master/doc/plugins.md) or [custom plugins](https://unifiedjs.com/learn/guide/create-a-plugin) to transform markdown content before it is translated to HTML (hast)
+- `remarkParseOptions` (Object) - configure how Markdown is parsed, same as [`remark-parse` options](https://github.com/remarkjs/remark/tree/main/packages/remark-parse#options)
+- `remarkPlugins` (Array) - [remark plugins](https://github.com/remarkjs/remark/blob/main/doc/plugins.md) or [custom plugins](https://unifiedjs.com/learn/guide/create-a-plugin) to transform markdown content before it is translated to HTML (hast)
 - `remarkToRehypeOptions` (Object) - configure how Markdown (mdast) is translated into HTML (hast), same as [`remark-rehype` options](https://github.com/remarkjs/remark-rehype#api)
-- `rehypePlugins` (Array) - [rehype plugins](https://github.com/rehypejs/rehype/blob/master/doc/plugins.md) or [custom plugins](https://unifiedjs.com/learn/guide/create-a-plugin) to transform HTML (hast) before it is translated to React elements.
+- `rehypePlugins` (Array) - [rehype plugins](https://github.com/rehypejs/rehype/blob/main/doc/plugins.md) or [custom plugins](https://unifiedjs.com/learn/guide/create-a-plugin) to transform HTML (hast) before it is translated to React elements.
 - `rehypeReactOptions` (Object) - configure how HTML (hast) is translated into React elements, same as [`rehype-react` options](https://github.com/rehypejs/rehype-react#options)
 
 ### Pass options to hook

src/index.ts

@@ -16,7 +16,7 @@ import rehypeReact, { Options as RehypeReactOptions } from 'rehype-react';
 export interface UseRemarkOptions {
   remarkParseOptions?: Partial<RemarkParseOptions>;
   remarkToRehypeOptions?: RemarkRehypeOptions;
-  rehypeReactOptions?: RehypeReactOptions<typeof createElement>;
+  rehypeReactOptions?: Partial<RehypeReactOptions<typeof createElement>>;
   remarkPlugins?: PluggableList;
   rehypePlugins?: PluggableList;
   onError?: (err: Error) => void;