Jamdesk Documentation logo

项目设置概览

创建项目、连接 GitHub、整理仓库,并决定谁可以阅读你的文档。如果你的站点尚未上线,请从这里开始。

Jamdesk 站点由仪表板中的一个项目、背后的一个 GitHub 仓库,以及一个描述导航结构的 docs.json 文件组成。本节介绍这些设置。尽早确定 URL 结构、语言和访问控制,因为一旦页面数量达到五十个,这些内容就很难更改。

如果要从其他平台迁移,请参阅迁移指南。

从仓库到上线网站

1
创建项目

从模板开始,或连接现有的 GitHub 仓库。你的站点将上线于 yourproject.jamdesk.app。

2
连接 GitHub

安装 GitHub App,使每次推送都自动部署。

3
整理仓库

添加 docs.json 文件和 MDX 页面。

核心设置

创建项目

从模板或现有仓库到上线站点

连接 GitHub

应用安装、仓库访问权限,以及推送时自动部署

目录结构

必需文件、页面目录、图片和代码片段

迁移指南

从其他文档平台迁移,支持自动或手动方式

Monorepo 支持

当文档不在仓库根目录时,将文档与代码放在一起维护

多语言支持

通过语言切换器提供多语言文档

网站结构

导航

组织文档的标签页、分组和页面

重定向

为移动或重命名的页面提供精确匹配和基于模式的重定向

隐私与访问权限

访问控制

完全公开、密码保护、混合模式或 SSO。比较各种选项。

密码保护

通过共享密码锁定整个站点或部分页面

单点登录(SSO)

通过你的身份提供商使用 SAML 或 OIDC