Skip to Content
🎉 Nextra 4.0 已发布。Dima Machina 正在 寻找新的工作或咨询机会
Documentation文件约定mdx-components.js

mdx-components.js 文件

mdx-components 文件是必需的,你可以通过 useMDXComponents 函数来自定义样式。

导出

useMDXComponents 函数

该文件必须导出一个名为 useMDXComponents 的函数。

mdx-components.js
import { useMDXComponents as getThemeComponents } from 'nextra-theme-docs' // nextra-theme-blog or your custom theme // Get the default MDX components const themeComponents = getThemeComponents() // Merge components export function useMDXComponents(components) { return { ...themeComponents, ...components } }

参数

components

在定义 MDX 组件时,导出函数接受单个参数 components: MDXComponents

  • 键是要覆盖的 HTML 元素的名称。
  • 值是要替换渲染的组件。
💡
Tip

你可以将 mdx-components 文件保存在项目根目录,或者在 src 目录中。

mdx-components 文件可以使用 .js.jsx.tsx 文件扩展名。

Last updated on