> ## Documentation Index
> Fetch the complete documentation index at: https://www.mintlify.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Monorepo 设置

> 在 monorepo 项目中配置文档路径和内容目录，使 Mintlify 仅从你指定的文档文件夹部署。

将 Mintlify 配置为从 monorepo 中的指定目录部署文档。此设置可让你在包含多个项目或服务的存储库中，将文档与代码一同维护。

典型的 monorepo 结构可能如下所示：

```text theme={null}
your-repo/
├── apps/
│   ├── web/
│   └── api/
├── docs/
│   ├── docs.json
│   └── quickstart.mdx
└── package.json
```

在此示例中，你需要将文档路径设置为 `/docs`。

<div id="prerequisites">
  ## 先决条件
</div>

* 拥有你在 Mintlify 项目的管理员权限。
* 将文档文件整理在 monorepo 中的独立目录内。
* 文档目录中包含有效的 `docs.json` 文件。

<div id="configure-monorepo-deployment">
  ## 配置 monorepo 部署
</div>

<Steps>
  <Step title="访问 Git 设置">
    在你的控制台前往 [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings)。

    <Frame>
      <img className="block dark:hidden my-0 pointer-events-none" src="https://mintcdn.com/mintlify/Y6rP0BmbzgwHuEoU/images/monorepo-light.png?fit=max&auto=format&n=Y6rP0BmbzgwHuEoU&q=85&s=796f90a80651694cb858c77f4f1145a8" alt="Git Settings 菜单中的项目设置面板。Set up as monorepo 开关已启用，并指定了 /docs 目录的路径。" width="1350" height="900" data-path="images/monorepo-light.png" />

      <img className="hidden dark:block my-0 pointer-events-none" src="https://mintcdn.com/mintlify/Y6rP0BmbzgwHuEoU/images/monorepo-dark.png?fit=max&auto=format&n=Y6rP0BmbzgwHuEoU&q=85&s=03624a6ce64b3c3d504e27585cf857aa" alt="Git Settings 菜单中的项目设置面板。Set up as monorepo 开关已启用，并指定了 /docs 目录的路径。" width="1350" height="900" data-path="images/monorepo-dark.png" />
    </Frame>
  </Step>

  <Step title="设置文档路径">
    1. 打开 **Set up as monorepo** 开关。
    2. 输入文档目录的相对路径。例如，如果文档位于 `docs` 目录，输入 `/docs`。

    <Note>
      路径末尾不要包含斜杠。
    </Note>

    3. 选择 **保存更改**。
  </Step>
</Steps>


## Related topics

- [多仓库部署](/zh/deploy/multi-repo.md)
- [GitLab](/zh/deploy/gitlab.md)
- [无头文档与自定义前端](/zh/guides/custom-frontend.md)