Jamdesk Documentation logo

项目设置

在 Jamdesk 仪表板的项目页面中配置项目名称、代码仓库、自定义域名、构建触发条件和高级设置。

在 Settings 页面中配置项目显示名称、关联的代码仓库、分支、环境变量、自定义域名和危险操作选项。

访问设置

  1. 在仪表板中选择项目
  2. 点击侧边栏中的 Settings

设置页面分为显示、代码仓库、团队、配置和通知等部分。

项目设置页面,显示项目名称和 ID 的显示设置,以及包含分支选择和 monorepo 开关的 Git 代码仓库配置

屏幕截图显示的是英文界面。

常规设置

项目名称

显示在仪表板中的名称。更改此名称不会影响已发布的文档。

子域名

您在 *.jamdesk.app 下的默认 URL。更改方法:

  1. 输入新的子域名
  2. 点击 Save
  3. 等待 DNS 传播(通常即时完成)

更改子域名不会导致现有链接失效。旧 URL 会重定向到新 URL。

仓库设置

已连接仓库

已关联的 GitHub 代码仓库。更改代码仓库需要先删除项目,再创建新项目。

分支

触发构建的 Git 分支,通常为 main 或 master。

文档路径

monorepo 中 docs.json 的路径(例如 packages/docs)。

如果 docs.json 位于代码仓库根目录,请留空。

构建设置

环境变量

为文档设置构建时变量:

  1. 点击 Add Variable
  2. 输入键和值
  3. 点击 Save

变量可在构建期间使用。您可以在文档中引用这些变量。

重新构建

点击 Rebuild,无需向 GitHub 推送更改即可启动全新构建。更改设置后请使用此选项。

自定义域名

在 Domains 部分添加自己的域名。请参阅自定义域名,了解设置说明。

危险区域

删除项目

永久删除项目及其所有相关数据:

  • 构建历史记录
  • 分析数据
  • 自定义域名配置

此操作无法撤销。如果团队成员需要继续访问,请考虑转移所有权。

相关文章

团队成员

邀请和移除协作者

自定义域名

设置自己的域名