跳转到主要内容
软件开发的核心原则之一是 DRY（Don’t Repeat Yourself，避免重复），这同样适用于文档。如果你发现在多个位置重复相同的内容，可以为该内容创建一个自定义片段。片段包含的内容可以导入到其他文件中复用，你可以控制片段在页面上的具体展示位置。如果之后需要更新内容，只需编辑片段本身，而不必修改所有使用该片段的文件。 片段不会渲染成独立页面，必须导入到其他文件中使用。

​
配置代码片段文件夹

默认情况下，任何位于名为 snippets 的文件夹中的文件都会被视为代码片段。你可以在 docs.json 的 snippets 字段中配置其他自定义文件夹来存放代码片段。 在 docs.json 中将 glob 模式 添加到 snippets 数组中，以指定哪些文件夹包含代码片段。
docs.json
{
  "snippets": [
    "components/**",
    "shared/reusable/**",
    "shared/common-component.mdx"
  ]
}

​
创建片段

在片段文件夹中创建一个文件，写入你想要复用的内容。片段可以包含 Mintlify 支持的所有内容类型，也可以导入其他片段。

​
将代码片段导入到页面中

要使用代码片段，请通过绝对路径或相对路径将它们导入到页面中。
  • 绝对导入：从项目根目录导入时，以 /snippets/ 或你自定义的代码片段路径开头。
  • 相对导入：使用 ./ 或 ../ 从当前文件所在位置相对导入代码片段。
相对导入支持 IDE 导航。在编辑器中按住 CMD 并单击代码片段名称即可直接跳转到该代码片段的定义。

​
导入文本

  1. 在代码片段文件中添加需要复用的内容。
snippets/my-snippet.mdx
  Hello world! This is my content I want to reuse across pages.
  1. 使用绝对路径或相对路径，将该片段导入目标文件中。
---
title: "An example page"
description: "This is an example page that imports a snippet."
---

import MySnippet from '/snippets/my-snippet.mdx';

The snippet content displays beneath this sentence.

<MySnippet/>

​
导入变量

在页面中引用代码片段（snippet）中的变量。
  1. 从代码片段（snippet）文件中导出变量。
snippets/custom-variables.mdx
  export const myName = "Ronan";

  export const myObject = { fruit: "strawberries" };
  1. 从目标文件中导入该代码片段并使用该变量。
destination-file.mdx
  ---
  title: "示例页面"
  description: "这是一个导入带有变量的代码片段的示例页面。"
  ---

  import { myName, myObject } from '/snippets/custom-variables.mdx';

  你好,我的名字是 {myName},我喜欢 {myObject.fruit}。

​
使用变量导入代码片段

在导入代码片段时，可使用变量向其传递数据。
  1. 在代码片段中添加变量，并在导入时通过属性传入值。在此示例中，变量是 {word}。
snippets/my-snippet.mdx
  我今天的关键词是 {word}。
  1. 使用该变量将代码片段导入目标文件。传入的属性会替换代码片段定义中的变量。
destination-file.mdx
  ---
  title: "示例页面"
  description: "这是一个导入带有变量的代码片段的示例页面。"
  ---

  import MySnippet from '/snippets/my-snippet.mdx';

  <MySnippet word="bananas" />

​
导入 React 组件

  1. 创建一个包含 JSX 组件的代码片段。有关更多信息，请参见 React 组件。
snippets/my-jsx-snippet.jsx
  export const MyJSXSnippet = () => {
    return (
      <div>
        <h1>你好,世界!</h1>
      </div>
    );
  };
创建 JSX 代码片段时，请使用箭头函数语法（=>），而不要使用函数声明。在代码片段中不支持使用 function 关键字。
  1. 导入该代码片段。
destination-file.mdx
  ---
  title: "示例页面"
  description: "这是一个导入包含 React 组件的代码片段的示例页面。"
  ---

  import { MyJSXSnippet } from '/snippets/my-jsx-snippet.jsx';

  <MyJSXSnippet />