`compileMdx` function

Exported from nextra/compile.

Signature

Parameters:

Name	Type	Default
`rawMdx`	`string`
`[1]?.staticImage`	`boolean`
`[1]?.search`	`boolean \| { codeblocks: boolean; }`
`[1]?.defaultShowCopyCode`	`boolean \| undefined`
`[1]?.readingTime`	`boolean \| undefined`
`[1]?.latex`	`boolean \| { renderer: "mathjax"; options?: { src?: string \| undefined; config?: MathJaxConfig \| undefined; } \| undefined; } \| { options: rehype_katex_lib_index_js.Options; renderer: "katex"; } \| undefined`
`[1]?.codeHighlight`	`boolean`
`[1]?.whiteListTagsStyling`	`string[] \| undefined`
`[1]?.mdxOptions`	`{ rehypePlugins?: any; remarkPlugins?: any; recmaPlugins?: any; format?: "detect" \| "mdx" \| "md" \| undefined; rehypePrettyCodeOptions?: Options \| undefined; } & Pick<ProcessorOptions, "jsx" \| ... 1 more ... \| "providerImportSource">`	`{}`
`[1]?.filePath`	`string`	`''`
`[1]?.useCachedCompiler`	`boolean`
`[1]?.isPageImport`	`boolean`	`false`
`[1]?.lastCommitTime`	`number`

Returns:

Promise<string>

Example


// Usage with MDXRemote
import { compileMdx } from 'nextra/compile'
import { MDXRemote } from 'nextra/mdx-remote'
 
const rawJs = await compileMdx(rawMdx)
const content = <MDXRemote compiledSource={rawJs} components={...} scope={...} />

compileMdx function

Signature

Example

`compileMdx` function