Skip to content
Mintlify
Mintlify

我可以重命名我的部署或组织吗?

在控制台中重命名部署或组织,并了解为什么子域名和组织 slug 只能通过删除并重新创建来更改。

Mintlify 中有些名称可以随时更改,有些则在创建时固定:

  • 可更改:组织名称、部署名称、docs.json 中的文档站点名称,以及自定义域名。
  • 固定:部署的子域名和组织的 slug。要更改这两者,只能删除后重新创建。

部署名称是显示在控制台顶栏中的展示名称。修改方法:

  1. 进入控制台的常规设置页面。
  2. Deployment name 字段中输入新名称。名称长度为 3 到 100 个字符,只能包含字母、数字、连字符和下划线。
  3. 保存更改。

重命名部署需要具有更新部署的权限。如果该字段不可编辑,请联系组织的 admin。参见角色和权限

子域名用于标识你的部署。它出现在 <subdomain>.mintlify.app URL 和控制台 URL app.mintlify.com/<org>/<subdomain> 中。部署创建后无法更改子域名。

要使用不同的子域名,请先用想要的名称创建一个新部署,然后删除旧部署:

  1. 创建一个连接到同一仓库的新部署。
  2. 如果你使用自定义域名,先从旧部署中移除,再添加到新部署。参见自定义域名
  3. 组织设置页面的危险区域部分中删除旧部署。参见删除部署

删除部署是永久性的,会移除所有部署数据,包括分析历史记录和所有关联的预览部署。控制台设置不会转移到新部署,请在创建新部署后重新配置。

组织名称是显示在控制台中的工作区展示名称。修改方法:

  1. 进入控制台的组织常规设置页面。
  2. Workspace 下的 Name 字段中输入新名称。
  3. 选择 Save

重命名组织需要具有更新组织的权限。如果该字段不可编辑,请联系组织的 admin。参见角色和权限

组织的 slug 是显示在控制台 URL app.mintlify.com/<org>/<subdomain> 中的唯一标识符。组织创建后无法更改 slug。要使用不同的 slug,请创建一个新组织,在其中重新创建你的部署,然后在组织设置页面的危险区域部分中删除旧组织。删除组织不可撤销,并且需要 admin 角色

读者很少能看到你的子域名和组织名称,因此你可能不需要重命名任何内容:

  • 文档上显示的站点名称来自 docs.json 中的 name 字段,可以随时更改。
  • 读者访问的 URL 可以是自定义域名,例如 docs.example.com,可以随时添加或更改。
Was this page helpful?Suggest editsRaise issue