Skip to content
Mintlify
Mintlify
部署

Monorepo 设置

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

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

Monorepo 部署使用单个包含 docs 子目录的仓库。要将来自多个仓库的内容合并到一个站点,请参阅多仓库部署

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

your-repo/
├── apps/
│   ├── web/
│   └── api/
├── docs/
│   ├── docs.json
│   └── quickstart.mdx
└── package.json

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

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

访问 Git 设置

在你的控制台前往 Git Settings

Git Settings 菜单中的项目设置面板,其中 docs.json is in a subdirectory 开关已启用,并指定了 /docs 目录的路径。

设置文档路径

  1. 打开 docs.json is in a subdirectory 开关。
  2. 输入文档目录的相对路径。例如,如果文档位于 docs 目录,输入 /docs

路径末尾不要包含斜杠。

  1. 选择 保存更改。 保存后会从配置的路径触发一次新的部署。
Was this page helpful?Suggest editsRaise issue