常见问题

Jamdesk 是一个文档平台，可根据 Markdown 文件构建文档站点。使用 MDX 编写内容，推送到 GitHub，站点即可自动部署，并自带搜索、分析和支持 AI 的 llms.txt。

无需编程。使用 MDX 编写内容就像使用文本编辑器：使用简单格式编写纯文本。如果需要，也可以使用组件，但这完全是可选的。

可以！我们提供 14 天免费试用，可完整使用所有功能。

Jamdesk 围绕 MDX 和 GitHub 构建：文档是仓库中的纯文本文件，而不是锁定在专有编辑器中。推送到 GitHub 后，站点无需构建配置或 CI/CD 管道，即可在 60 秒内完成部署。每个站点都会自动获得 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 添加自定义域名。SSL 证书会自动配置。

DNS 更改通常会在几小时内传播完成，但最长可能需要 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 可先查看计划中的更改；只有更正后的锚点确实对应某个标题时，链接才会被修改，存在歧义的情况会留待手动检查。详情请参阅 自动修复失效链接。

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

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

页面数量没有硬性限制。大多数文档站点都可以很好地支持数百个页面。

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

不会。Jamdesk 不会替你翻译内容。你需要提供翻译后的 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 来编写文档，因此拥有文档分支推送权限的任何人都可以发布更改。读者查看已发布的站点：所有人（公开模式）、拥有密码的任何人（密码模式），或通过你的 IdP 登录的任何人（SSO）。仪表板团队成员是另一种概念：他们管理构建和分析，但不会直接编写内容。请参阅 访问控制。