Skip to content

Commit

Permalink
chore: update reference to MDX options (#280)
Browse files Browse the repository at this point in the history
  • Loading branch information
Bryce Kalow committed Jun 3, 2022
1 parent 23a910d commit 1ed5e9f
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions README.md
Expand Up @@ -300,22 +300,20 @@ This library exposes a function and a component, `serialize` and `<MDXRemote />`
{
// made available to the arguments of any custom mdx component
scope: {},
// MDX's available options at time of writing pulled directly from
// https://github.com/mdx-js/mdx/blob/master/packages/mdx/index.js
// MDX's available options, see the MDX docs for more info.
// https://mdxjs.com/packages/mdx/#compilefile-options
mdxOptions: {
remarkPlugins: [],
rehypePlugins: [],
hastPlugins: [],
compilers: [],
filepath: '/some/file/path',
format: 'mdx'
},
// Indicates whether or not to parse the frontmatter from the mdx source
parseFrontmatter: false,
}
)
```

Visit <https://github.com/mdx-js/mdx/blob/master/packages/mdx/index.js> for available `mdxOptions`.
Visit <https://mdxjs.com/packages/mdx/#compilefile-options> for available `mdxOptions`.

- **`<MDXRemote compiledSource={string} components?={object} scope?={object} lazy?={boolean} />`**

Expand Down

0 comments on commit 1ed5e9f

Please sign in to comment.