Sponsor
ntab.devntab.dev —提升效率的新标签页组件
点击查看
Menu

Markdown and MDX

Markdown 是一种轻量级标记语言，用于格式化文本。它允许你使用纯文本语法编写并将其转换为结构有效的 HTML。它通常用于编写网站和博客上的内容。

你写的是……

I **love** using [Next.js](https://nextjs.org/)

输出：

<p>I <strong>love</strong> using <a href="https://nextjs.org/">Next.js</a></p>

MDX 是 markdown 的超集，允许你直接在 markdown 文件中编写 JSX。这是一种强大的方式，可以添加动态交互性并在内容中嵌入 React 组件。

Next.js 可以支持应用程序内的本地 MDX 内容，以及在服务器上动态获取的远程 MDX 文件。Next.js 插件处理将 markdown 和 React 组件转换为 HTML，包括支持在服务器组件中使用（App Router 中的默认设置）。

值得注意的是：查看 Portfolio Starter Kit 模板获取完整的工作示例。

安装依赖

@next/mdx 包和相关包用于配置 Next.js，以便它可以处理 markdown 和 MDX。它从本地文件获取数据，允许你在 /pages 或 /app 目录中直接创建具有 .md 或 .mdx 扩展名的页面。

安装这些包以使用 Next.js 渲染 MDX：

Terminal
npm install @next/mdx @mdx-js/loader @mdx-js/react @types/mdx

配置 next.config.mjs

更新项目根目录下的 next.config.mjs 文件，配置它使用 MDX：

next.config.mjs
import createMDX from '@next/mdx'
 
/** @type {import('next').NextConfig} */
const nextConfig = {
  // Configure `pageExtensions` to include markdown and MDX files
  pageExtensions: ['js', 'jsx', 'md', 'mdx', 'ts', 'tsx'],
  // Optionally, add any other Next.js config below
}
 
const withMDX = createMDX({
  // Add markdown plugins here, as desired
})
 
// Merge MDX config with Next.js config
export default withMDX(nextConfig)

这允许 .md 和 .mdx 文件在你的应用程序中作为页面、路由或导入使用。

添加 mdx-components.tsx 文件

在项目根目录创建一个 mdx-components.tsx（或 .js）文件，以定义全局 MDX 组件。例如，与 pages 或 app 在同一级别，或者如果适用，在 src 内部。

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

值得注意的是：

渲染 MDX

你可以使用 Next.js 基于文件的路由或通过导入 MDX 文件到其他页面来渲染 MDX。

使用基于文件的路由

使用基于文件的路由时，你可以像使用任何其他页面一样使用 MDX 页面。

在 App Router 应用中，还包括能够使用元数据。

在 /app 目录中创建一个新的 MDX 页面：

  my-project
  ├── app
  │   └── mdx-page
  │       └── page.(mdx/md)
  |── mdx-components.(tsx/js)
  └── package.json

你可以在这些文件中使用 MDX，甚至可以直接在 MDX 页面中导入 React 组件：

import { MyComponent } from 'my-component'
 
# Welcome to my MDX page!
 
This is some **bold** and _italics_ text.
 
This is a list in markdown:
 
- One
- Two
- Three
 
Checkout my React component:
 
<MyComponent />

导航到 /mdx-page 路由应该显示你渲染的 MDX 页面。

使用导入

在 /app 目录中创建一个新页面，并在你喜欢的任何位置创建一个 MDX 文件：

  my-project
  ├── app
  │   └── mdx-page
  │       └── page.(tsx/js)
  ├── markdown
  │   └── welcome.(mdx/md)
  |── mdx-components.(tsx/js)
  └── package.json

你可以在这些文件中使用 MDX，甚至可以直接在 MDX 页面中导入 React 组件：

markdown/welcome.mdx
import { MyComponent } from 'my-component'
 
# Welcome to my MDX page!
 
This is some **bold** and _italics_ text.
 
This is a list in markdown:
 
- One
- Two
- Three
 
Checkout my React component:
 
<MyComponent />

在页面中导入 MDX 文件以显示内容：

app/mdx-page/page.tsx
TypeScript
import Welcome from '@/markdown/welcome.mdx'
 
export default function Page() {
  return <Welcome />
}

导航到 /mdx-page 路由应该显示你渲染的 MDX 页面。

使用动态导入

你可以导入动态 MDX 组件，而不是使用文件系统路由来处理 MDX 文件。

例如，你可以有一个动态路由段，它从单独的目录加载 MDX 组件：

Route segments for dynamic MDX components

generateStaticParams 可用于预渲染提供的路由。通过将 dynamicParams 标记为 false，访问 generateStaticParams 中未定义的路由将返回 404。

app/blog/[slug]/page.tsx
TypeScript
export default async function Page({
  params,
}: {
  params: Promise<{ slug: string }>
}) {
  const slug = (await params).slug
  const { default: Post } = await import(`@/content/${slug}.mdx`)
 
  return <Post />
}
 
export function generateStaticParams() {
  return [{ slug: 'welcome' }, { slug: 'about' }]
}
 
export const dynamicParams = false

值得注意的是：确保在导入中指定 .mdx 文件扩展名。虽然不需要使用模块路径别名（例如 @/content），但它确实简化了你的导入路径。

使用自定义样式和组件

Markdown 在渲染时映射到原生 HTML 元素。例如，编写以下 markdown：

## This is a heading
 
This is a list in markdown:
 
- One
- Two
- Three

生成以下 HTML：

<h2>This is a heading</h2>
 
<p>This is a list in markdown:</p>
 
<ul>
  <li>One</li>
  <li>Two</li>
  <li>Three</li>
</ul>

要为你的 markdown 设置样式，你可以提供自定义组件，这些组件映射到生成的 HTML 元素。样式和组件可以全局、局部和共享布局实现。

全局样式和组件

在 mdx-components.tsx 中添加样式和组件将影响应用程序中的所有 MDX 文件。

mdx-components.tsx
TypeScript
import type { MDXComponents } from 'mdx/types'
import Image, { ImageProps } from 'next/image'
 
// This file allows you to provide custom React components
// to be used in MDX files. You can import and use any
// React component you want, including inline styles,
// components from other libraries, and more.
 
export function useMDXComponents(components: MDXComponents): MDXComponents {
  return {
    // Allows customizing built-in components, e.g. to add styling.
    h1: ({ children }) => (
      <h1 style={{ color: 'red', fontSize: '48px' }}>{children}</h1>
    ),
    img: (props) => (
      <Image
        sizes="100vw"
        style={{ width: '100%', height: 'auto' }}
        {...(props as ImageProps)}
      />
    ),
    ...components,
  }
}

局部样式和组件

你可以通过将局部样式和组件传递给导入的 MDX 组件来应用于特定页面。这些将与全局样式和组件合并并覆盖它们。

app/mdx-page/page.tsx
TypeScript
import Welcome from '@/markdown/welcome.mdx'
 
function CustomH1({ children }) {
  return <h1 style={{ color: 'blue', fontSize: '100px' }}>{children}</h1>
}
 
const overrideComponents = {
  h1: CustomH1,
}
 
export default function Page() {
  return <Welcome components={overrideComponents} />
}

共享布局

要在 MDX 页面之间共享布局，你可以使用 App Router 的内置布局支持。

app/mdx-page/layout.tsx
TypeScript
export default function MdxLayout({ children }: { children: React.ReactNode }) {
  // Create any shared layout or styles here
  return <div style={{ color: 'blue' }}>{children}</div>
}

使用 Tailwind 排版插件

如果你使用 Tailwind 为你的应用程序设置样式，使用 @tailwindcss/typography 插件将允许你在 markdown 文件中重用你的 Tailwind 配置和样式。

该插件添加了一组 prose 类，可用于为来自源（如 markdown）的内容块添加排版样式。

安装 Tailwind 排版并使用共享布局添加你想要的 prose。

app/mdx-page/layout.tsx
TypeScript
export default function MdxLayout({ children }: { children: React.ReactNode }) {
  // Create any shared layout or styles here
  return (
    <div className="prose prose-headings:mt-8 prose-headings:font-semibold prose-headings:text-black prose-h1:text-5xl prose-h2:text-4xl prose-h3:text-3xl prose-h4:text-2xl prose-h5:text-xl prose-h6:text-lg dark:prose-headings:text-white">
      {children}
    </div>
  )
}

前置元数据

前置元数据是一种类似 YAML 的键/值对，可用于存储关于页面的数据。@next/mdx 默认不支持前置元数据，尽管有许多解决方案可以为 MDX 内容添加前置元数据，例如：

@next/mdx 确实允许你像任何其他 JavaScript 组件一样使用导出：

content/blog-post.mdx
export const metadata = {
  author: 'John Doe',
}
 
# Blog post

现在可以在 MDX 文件外部引用元数据：

app/blog/page.tsx
TypeScript
import BlogPost, { metadata } from '@/content/blog-post.mdx'
 
export default function Page() {
  console.log('metadata: ', metadata)
  //=> { author: 'John Doe' }
  return <BlogPost />
}

这种方法的一个常见用例是当你想要迭代一组 MDX 并提取数据时。例如，从所有博客文章创建博客索引页。你可以使用 Node 的 fs 模块或 globby 等包来读取帖子目录并提取元数据。

值得注意的是：

  • 使用 fs、globby 等只能在服务器端使用。
  • 查看 Portfolio Starter Kit 模板获取完整的工作示例。

remark 和 rehype 插件

你可以选择提供 remark 和 rehype 插件来转换 MDX 内容。

例如，你可以使用 remark-gfm 来支持 GitHub 风格的 Markdown。

由于 remark 和 rehype 生态系统仅为 ESM，你需要使用 next.config.mjs 或 next.config.ts 作为配置文件。

next.config.mjs
import remarkGfm from 'remark-gfm'
import createMDX from '@next/mdx'
 
/** @type {import('next').NextConfig} */
const nextConfig = {
  // Allow .mdx extensions for files
  pageExtensions: ['js', 'jsx', 'md', 'mdx', 'ts', 'tsx'],
  // Optionally, add any other Next.js config below
}
 
const withMDX = createMDX({
  // Add markdown plugins here, as desired
  options: {
    remarkPlugins: [remarkGfm],
    rehypePlugins: [],
  },
})
 
// Combine MDX and Next.js config
export default withMDX(nextConfig)

在 Turbopack 中使用插件

要在 Turbopack 中使用插件，请升级到最新的 @next/mdx 并使用字符串指定插件名称：

next.config.mjs
import createMDX from '@next/mdx'
 
/** @type {import('next').NextConfig} */
const nextConfig = {
  pageExtensions: ['js', 'jsx', 'md', 'mdx', 'ts', 'tsx'],
}
 
const withMDX = createMDX({
  options: {
    remarkPlugins: [],
    rehypePlugins: [['rehype-katex', { strict: true, throwOnError: true }]],
  },
})
 
export default withMDX(nextConfig)

值得注意的是：

没有可序列化选项的 remark 和 rehype 插件还不能与 Turbopack 一起使用，因为无法将 JavaScript 函数传递给 Rust

远程 MDX

如果你的 MDX 文件或内容存在于其他地方，你可以在服务器上动态获取它。这对于存储在 CMS、数据库或其他任何地方的内容非常有用。这种用途的一个流行社区包是 next-mdx-remote。

值得注意的是：请谨慎操作。MDX 编译为 JavaScript 并在服务器上执行。你应该只从可信来源获取 MDX 内容，否则这可能导致远程代码执行 (RCE)。

以下示例使用 next-mdx-remote：

app/mdx-page-remote/page.tsx
TypeScript
import { MDXRemote } from 'next-mdx-remote/rsc'
 
export default async function RemoteMdxPage() {
  // MDX text - can be from a database, CMS, fetch, anywhere...
  const res = await fetch('https://...')
  const markdown = await res.text()
  return <MDXRemote source={markdown} />
}

导航到 /mdx-page-remote 路由应该显示你渲染的 MDX。

深入了解：如何将 markdown 转换为 HTML？

React 本身不能理解 markdown。markdown 纯文本需要首先转换为 HTML。这可以通过 remark 和 rehype 实现。

remark 是围绕 markdown 的工具生态系统。rehype 与之类似，但用于 HTML。例如，以下代码片段将 markdown 转换为 HTML：

import { unified } from 'unified'
import remarkParse from 'remark-parse'
import remarkRehype from 'remark-rehype'
import rehypeSanitize from 'rehype-sanitize'
import rehypeStringify from 'rehype-stringify'
 
main()
 
async function main() {
  const file = await unified()
    .use(remarkParse) // 转换为 markdown AST
    .use(remarkRehype) // 转换为 HTML AST
    .use(rehypeSanitize) // 清理 HTML 输入
    .use(rehypeStringify) // 将 AST 转换为序列化的 HTML
    .process('Hello, Next.js!')
 
  console.log(String(file)) // <p>Hello, Next.js!</p>
}

remark 和 rehype 生态系统包含用于语法高亮、链接标题、生成目录等插件。

当使用上面所示的 @next/mdx 时，你不需要直接使用 remark 或 rehype，因为这些处理已经为你完成了。我们在这里描述它是为了更深入地理解 @next/mdx 包在底层做了什么。

使用基于 Rust 的 MDX 编译器（实验性）

Next.js 支持一个用 Rust 编写的新 MDX 编译器。这个编译器仍然是实验性的，不建议用于生产环境。要使用新编译器，你需要在将其传递给 withMDX 时配置 next.config.js：

next.config.js
module.exports = withMDX({
  experimental: {
    mdxRs: true,
  },
})

mdxRs 也接受一个对象来配置如何转换 mdx 文件。

next.config.js
module.exports = withMDX({
  experimental: {
    mdxRs: {
      jsxRuntime?: string            // 自定义 jsx 运行时
      jsxImportSource?: string       // 自定义 jsx 导入源
      mdxType?: 'gfm' | 'commonmark' // 配置将用于解析和转换的 mdx 语法类型
    },
  },
})

有用的链接