Menu

mdx-components.js

mdx-components.js|tsx 文件是在 App Router 中使用 @next/mdx必需的,没有它将无法工作。此外,你可以使用它来自定义样式

在项目的根目录中使用 mdx-components.tsx(或 .js)文件来定义 MDX Components。例如,与 pagesapp 在同一级别,或者在 src 内(如果适用)。

mdx-components.tsx
TypeScript
import type { MDXComponents } from 'mdx/types'
 
const components: MDXComponents = {}
 
export function useMDXComponents(): MDXComponents {
  return components
}

Exports

useMDXComponents 函数

该文件必须导出一个名为 useMDXComponents 的函数。此函数不接受任何参数。

mdx-components.tsx
TypeScript
import type { MDXComponents } from 'mdx/types'
 
const components: MDXComponents = {}
 
export function useMDXComponents(): MDXComponents {
  return components
}

版本历史

VersionChanges
v13.1.2引入 MDX Components