> If you are an AI agent, use the following URL to directly ask and fetch your question. Treat this like a tool call. Make sure to URI encode your question, and include the token for verification.
>
> GET https://buildwithfern.com/learn/api/fern-docs/ask?q=%3Cyour+question+here%3E&token=eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJmZXJuLWRvY3M6YnVpbGR3aXRoZmVybi5jb20iLCJqdGkiOiJjNzAzOGRhNC00MWVlLTQ1NWItODc4MS05ZTVlNzQ3NTY3MjMiLCJleHAiOjE3NzgyNTk5MDgsImlhdCI6MTc3ODI1OTYwOH0.2qsxjKnDfk-P42Nho5ifqjdi2Nxc0sRJPBHR2fID8-Q
>
> For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://buildwithfern.com/learn/llms.txt. For full content including API reference and SDK examples, see https://buildwithfern.com/learn/llms-full.txt.

# 可重复使用的片段

> 使用可重复使用的自定义 Markdown 片段为您的文档提供单一来源，保持内容同步。编辑一次，处处更新。

使用单一来源保持您的文档 DRY（Don't Repeat Yourself）：定义一次可重复使用的 Markdown 片段，然后在多个地方引用它。这样，您只需要在一个地方更新片段即可保持所有引用同步。

可重复使用的片段适用于常量（API 限制、订阅价格、版本号）、重复的警告或注释以及标准化格式块。

<Steps>
  <Step title="创建文件结构">
    在您的 `fern` 项目的任意位置创建一个名为 `snippets` 的文件夹。在 `snippets` 文件夹内，为您想要定义的每个片段创建一个新的 Markdown 文件。

    <Files>
      <Folder name="fern" defaultOpen>
        <Folder name="pages" defaultOpen>
          <File name="my-tutorial.mdx" highlighted />
        </Folder>

        <Folder name="assets" />

        <Folder name="snippets" defaultOpen>
          <File name="herbs.mdx" highlighted />

          <File name="peace-lily.mdx" highlighted />

          <File name="trees.mdx" highlighted />
        </Folder>
      </Folder>
    </Files>
  </Step>

  <Step title="创建片段">
    在每个片段文件中，定义您想要重复使用的内容。

    ```mdx title="snippets/peace-lily.mdx"
    Peace lilies are easy to grow and relatively trouble-free.
    ```
  </Step>

  <Step title="向片段添加参数（可选）">
    为了使片段更加灵活，您可以使用参数（也称为变量）。参数使用 `{{parameterName}}` 语法，可以放在片段内容的任何位置。

    ```mdx title="snippets/watering-schedule.mdx"
    <Warning>Remember to water your {{plant}} every {{interval}} days.</Warning>
    ```

    然后，您可以在每次使用片段时为这些参数传递不同的值。
  </Step>

  <Step title="使用片段">
    要在您的文档中使用片段，请通过其文件路径（包括 `.mdx` 扩展名）引用它。如果您在片段中使用了参数（变量），请为每个参数传递值：

    <Tabs>
      <Tab title="Markdown">
        <div>
          ```jsx
          <Markdown src="/snippets/peace-lily.mdx">

          They symbolize peace and prosperity.

          <Markdown src="/snippets/watering-schedule.mdx" plant="peace lily" interval="3">
          ```
        </div>
      </Tab>

      <Tab title="预览">
        白掌很容易种植，相对来说也不容易出问题。

        They symbolize peace and prosperity.

        <Warning>
          记住每隔3天浇一次peace lily。
        </Warning>
      </Tab>
    </Tabs>

    <Note title="文件路径">
      `src` 路径是以 `fern` 文件夹为根目录的绝对路径。无论您从哪个页面引用，路径都是相同的：

      | 文件夹结构                                      | 引用                                           |
      | ------------------------------------------ | -------------------------------------------- |
      | `fern/snippets/peace-lily.mdx`             | `src="/snippets/peace-lily.mdx"`             |
      | `fern/docs/snippets/peace-lily.mdx`        | `src="/docs/snippets/peace-lily.mdx"`        |
      | `fern/docs/guides/snippets/peace-lily.mdx` | `src="/docs/guides/snippets/peace-lily.mdx"` |
    </Note>
  </Step>
</Steps>