快速入门：5 分钟部署
创建 Jamdesk 文档站点并部署到您的子域名。无需构建工具，只需 GitHub 账户和两个文件。
Jamdesk 是一款文档软件，可将包含 Markdown 的 GitHub 仓库发布为托管文档站点。它会自动生成 AI 可读的输出：llms.txt、每页的 .md 端点以及 MCP 服务器。
用两个文件即可部署文档站点：docs.json 和一个 MDX 页面。请选择与您起点相符的路径。
前置条件
您需要：
- 一个 GitHub 账户
- 一个包含您文档的仓库（或者我们为您创建一个）
选项 1：从入门模板开始
这是最快的入门方式。入门模板包含示例内容、OpenAPI 规范以及每个组件的示例。先了解工作原理，再替换为您自己的内容。
前往 dashboard.jamdesk.com，使用 GitHub 注册。
点击 New Project → From Template → Starter Docs。
Jamdesk 会为您创建一个已预先配置好所有内容的 GitHub 仓库。
您的文档已部署到 your-project.jamdesk.app。编辑 MDX 文件并推送，站点会自动重新构建。
您也可以直接克隆入门模板：git clone https://github.com/jamdesk/starter-docs.git my-docs
想让部分页面保持私密？ 在任意 MDX 文件的 frontmatter 中添加 private: true。下次构建后，在 Project Settings 中设置密码。关于全部四种选项（公开、全站密码、混合、SSO），请参阅访问控制。
选项 2：连接现有仓库
如果您已有包含 Jamdesk 可用文档的仓库，可以直接连接。如果您正从 Mintlify 或其他文档平台迁移，请先使用选项 3。
前往 dashboard.jamdesk.com，使用 GitHub 注册。
您的文档已部署到 your-project.jamdesk.app。Jamdesk 会自动为 AI 工具生成 llms.txt。
每次推送到您所连接的分支都会触发自动重新构建。
选项 3：从 Mintlify 或其他文档平台迁移
如果您的文档已在 Mintlify、GitBook、Docusaurus、ReadMe、Confluence 或其他平台上，请在创建新项目之前先阅读迁移指南。该指南涵盖了用于 Mintlify 的 jamdesk migrate 命令，以及其他文档工具的手动步骤。然后使用选项 2连接迁移后的仓库。
文档项目包含什么
一个最简的 Jamdesk 项目包含两样东西：
my-docs/
├── docs.json # Configuration
└── introduction.mdx # Your first page对于较大的站点，请参阅目录结构，了解推荐的文件夹、资源和代码片段组织方式。
docs.json
定义站点的配置文件：
{
"$schema": "https://jamdesk.com/docs.json",
"name": "My Docs",
"theme": "jam",
"navigation": {
"groups": [
{
"group": "Getting Started",
"pages": ["introduction"]
}
]
}
}所有配置选项请参阅 docs.json 参考。
MDX 页面
以 MDX 编写的文档页面：
---
title: Introduction
description: Welcome to the docs
---
# Welcome
This is your first documentation page.关于 frontmatter、标题、链接和组件语法，请参阅 MDX 基础。
本地开发
在推送到 GitHub 之前，使用 Jamdesk CLI 在本地预览更改。它可以在 MDX 语法错误到达线上站点之前将其捕获。关于每种安装方式和命令，请参阅 Jamdesk CLI 概览。
运行方式：
npm install -g jamdesk
cd my-docs
jamdesk dev打开 http://localhost:3000 即可查看您的文档，并支持热重载。
添加更多页面
- 创建一个新的 MDX 文件：
---
title: Getting Started
description: Learn the basics
---
Your content here...- 将其添加到
docs.json：
{
"navigation": {
"groups": [
{
"group": "Getting Started",
"pages": ["introduction", "getting-started"]
}
]
}
}- 推送到 GitHub。您的新页面会自动部署。
关于更多链接模式（包括锚点和卡片），请参阅链接与导航。
自定义域名
在 Settings → Domains 中添加您自己的域名：
- 输入您的域名（例如
docs.example.com） - 添加所示的 DNS 记录
- 等待验证（最长 48 小时）
SSL 证书会自动配置。完整指南 →
需要帮助？
浏览帮助中心，获取设置、账单和故障排除指南。如需联系人工支持，请打开任意 Jamdesk 页面右下角的聊天窗口，或发送邮件至 support@jamdesk.com。我们会尽快回复。
完整参考
参考文档涵盖每个 MDX 组件、每条 CLI 命令以及每个 docs.json 配置选项。