常见问题

Jamdesk 是一个文档平台，可根据 Markdown 文件构建文档站点。使用 MDX 编写内容并推送到 GitHub，即可部署站点，并获得搜索、分析功能，以及供 AI 工具使用的 llms.txt 文件。

不需要。MDX 是带有简单格式的纯文本。组件是可选的。

可以。我们提供 14 天免费试用，期间可使用所有功能。

你的文档是 GitHub 仓库中的纯 MDX 文件，不会被锁定在专有编辑器中。推送到 GitHub 后，站点会在 60 秒内完成部署。无需设置构建配置或 CI/CD 流水线。每个站点都附带 llms.txt 和 MCP 服务器。Claude 和 ChatGPT 等 AI 工具可以直接读取最新文档。访问者还可以使用内置的 AI 聊天助手，根据你的文档获取问题答案。

大多数文档站点会在 30–60 秒内完成构建。页面较多的大型站点可能需要更长时间。

可以。使用 Jamdesk CLI（jamdesk dev）在本地预览，并启用热重载。只有在推送到 GitHub 或运行 jamdesk deploy 后，更改才会上线。

可以。在项目目录中运行 jamdesk deploy。CLI 会打包并上传文件，然后触发构建。无需 Git 仓库。详情请参阅 CLI 部署指南。

推送到已连接的 GitHub 分支会触发构建。你也可以从仪表板触发构建，或在 CLI 中运行 jamdesk deploy。

可以。在项目中前往 Deployments。找到先前的构建，然后点击 Rollback。

Pro 套餐为每月 $29，包含一个文档项目。每增加一个项目，每月需支付 $15。详情请参阅套餐与定价。

没有。我们提供 14 天免费试用。试用结束后，你需要订阅 Pro 套餐。

我们接受 Visa、Mastercard、American Express 和 Discover 信用卡。

首次付款后的 30 天内可以申请退款。请联系支持团队申请。

可以。在 Settings → Domains 中添加自定义域名。Jamdesk 会为你配置 SSL 证书。

通常需要几个小时，最长可能需要 48 小时。

可以。使用反向代理（Cloudflare、AWS、nginx）将 Jamdesk 部署在子路径下。请参阅子路径托管。

打开项目并前往 Settings → Members。在 Invite Member 字段中输入对方的电子邮件地址，然后点击 Invite。对方会收到一封包含项目加入链接的电子邮件。

受邀者需要拥有 Jamdesk 账户。如果对方还没有账户，邀请流程会提示其创建账户。已经是成员，但邀请链接显示“already been accepted”？请登录，随后你会返回项目页面。有关角色和成员数量限制，请参阅团队成员。

所有套餐均支持无限名成员，且不收取额外费用。

团队成员可以查看构建并触发重新构建。文档在你的 GitHub 仓库中编辑。任何有权访问该仓库的人都可以编辑文档。

前往 Settings → Members。在要提升为所有者的成员旁边点击 Transfer Ownership。新所有者必须是现有团队成员。

凭据存储在 ~/.jamdeskrc 中，这是一个权限为 0600 的 JSON 文件（只有你的用户可以读取）。文件中保存刷新令牌、电子邮件地址和用户 ID。运行 jamdesk logout 可清除这些信息。

刷新令牌已失效。密码更改、账户删除或长时间未活动后，都可能发生这种情况。运行 jamdesk login 以获取新会话。

可以。基于浏览器的登录方式无法在无头环境中使用。请先在本地计算机上登录，再将 ~/.jamdeskrc 复制到 CI 运行器。刷新令牌会在该环境中用于身份验证。

运行 jamdesk fix。该命令会修复只有一个明确正确目标的失效内部链接（拼写错误的锚点和跨语言环境的锚点偏移）。预览后，它会编辑本地 .mdx 文件。运行 jamdesk fix --dry-run 可先查看计划进行的更改。该命令只会处理修正后的锚点确实对应某个标题的链接。有歧义的情况会保留，供手动检查。请参阅自动修复失效链接。

MDX（Markdown + JSX）和标准 Markdown 文件。

可以。在 MDX 中使用 export const 定义内联组件，也可以在 /snippets 目录中创建可复用组件。对于使用 hooks 的交互式组件，请使用带有 'use client' 的 .tsx 文件。请参阅自定义 React 组件和代码片段。

没有硬性限制。包含数百个页面的站点也能正常构建和运行。

支持。在导航配置中使用 languages 属性添加语言切换器。每种语言都有自己的导航结构和内容。请参阅多语言支持。

不会。你需要提供翻译后的 MDX 文件。Jamdesk 会构建路由、导航、语言切换器和 RTL 样式。你可以通过自己的工作流程获取翻译（人工翻译、机器翻译或 LLM 翻译），并将翻译文件放入带有语言前缀的目录（es/、fr/ 等）。有关目录结构和配置，请参阅多语言支持。

带有。每个 Jamdesk 站点都内置聊天助手，可根据文档回答访问者的问题。该功能默认启用。详情请参阅 AI 聊天。

不需要。所有套餐均包含 AI 聊天功能。

可以。在 docs.json 中将 chat.enabled 设为 false：

{ "chat": { "enabled": false } }

下次构建时，聊天面板和键盘快捷键将被移除。

只使用已发布的文档页面。每次构建都会将内容编入向量数据库索引。Jamdesk 会检索与访问者问题相关的部分，并将其作为上下文发送给 Claude。AI 无法访问文档以外的数据。

可以。在 frontmatter 中将内部页面标记为 private: true，或在 docs.json 的 auth.password.private[] 下列出这些页面的路径。私有页面会显示解锁屏幕。所有页面都保留在同一个项目中，共用一个仓库和一次构建。请参阅访问控制和密码保护。

在 docs.json 中将 auth.password.enabled: true 设为启用，然后推送更改。在仪表板的 Project Settings → Password Protection 中设置密码。访问者输入密码前会看到解锁屏幕。请参阅密码保护。

可以，但仅限 Enterprise 套餐。通过单点登录，读者可以使用你的身份提供商（Okta、Google Workspace、Azure AD 等）进行身份验证，无需共用密码，并可获得完整的审计记录和即时取消访问权限的能力。请参阅 SSO 或联系 Enterprise 销售团队。

通常不需要。在同一个项目中为内部页面设置 private: true 即可。这样可以共用一个仓库和一个仪表板。只有在受众需要使用不同的品牌、自定义域名或分析数据时，才需要使用两个项目。有关适用方式，请参阅访问控制。

编辑者通过向已连接的 GitHub 仓库提交 MDX 来编写文档。只有推送者是 Jamdesk 项目成员或已授权的自动化账户时，推送才会触发构建。读者查看已发布的站点：所有人（公开模式）、任何知道密码的人（密码模式），或任何通过你的 IdP 登录的人（SSO）。仪表板团队成员可以管理构建、分析数据和设置。成为成员也意味着其推送可以触发构建。请参阅访问控制。