mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
b0ab4fa68b
Generated-By: mintlify-agent Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
62 lines
1.8 KiB
Plaintext
62 lines
1.8 KiB
Plaintext
---
|
|
title: "Monorepo 设置"
|
|
description: "在 monorepo 项目中配置文档路径和内容目录，使 Mintlify 仅从你指定的文档文件夹部署。"
|
|
keywords: ["monorepo", "content 目录", "多项目存储库"]
|
|
---
|
|
|
|
将 Mintlify 配置为从 monorepo 中的指定目录部署文档。此设置可让你在包含多个项目或服务的存储库中，将文档与代码一同维护。
|
|
|
|
典型的 monorepo 结构可能如下所示：
|
|
|
|
```text
|
|
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="/images/monorepo-light.png"
|
|
alt="Git Settings 菜单中的项目设置面板。Set up as monorepo 开关已启用，并指定了 /docs 目录的路径。"
|
|
/>
|
|
<img
|
|
className="hidden dark:block my-0 pointer-events-none"
|
|
src="/images/monorepo-dark.png"
|
|
alt="Git Settings 菜单中的项目设置面板。Set up as monorepo 开关已启用，并指定了 /docs 目录的路径。"
|
|
/>
|
|
</Frame>
|
|
|
|
</Step>
|
|
<Step title="设置文档路径">
|
|
1. 打开 **Set up as monorepo** 开关。
|
|
2. 输入文档目录的相对路径。例如，如果文档位于 `docs` 目录，输入 `/docs`。
|
|
<Note>
|
|
路径末尾不要包含斜杠。
|
|
</Note>
|
|
3. 选择 **保存更改**。
|
|
</Step>
|
|
</Steps> |