NNext.js 中文网 GitHub

mdx-components.js

mdx-components.js 文件的 API 参考。

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

在项目根目录使用 mdx-components.tsx(或 .js)文件来定义 MDX 组件。例如,与 pages 或 app 同级,或者如果适用,放在 src 目录内。

mdx-components.tsx
import type { MDXComponents } from 'mdx/types'

const components: MDXComponents = {}

export function useMDXComponents(): MDXComponents {
  return components
}
mdx-components.js
const components = {}

export function useMDXComponents() {
  return components
}

导出#

useMDXComponents 函数#

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

mdx-components.tsx
import type { MDXComponents } from 'mdx/types'

const components: MDXComponents = {}

export function useMDXComponents(): MDXComponents {
  return components
}
mdx-components.js
const components = {}

export function useMDXComponents() {
  return components
}

版本历史#

VersionChanges
v13.1.2新增 MDX 组件
Next.js 中文网