Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update reference to MDX options #280

Merged
merged 1 commit into from
Jun 3, 2022
Merged

chore: update reference to MDX options #280

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
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