快速开始：5 分钟完成部署

Jamdesk 是文档软件，可以将 GitHub 仓库中的 Markdown 发布为托管文档站点，并自动生成 AI 可读的输出（llms.txt、每页的 .md 端点和 MCP 服务器）。

只需两个文件即可部署文档站点：docs.json 和一个 MDX 页面。根据你的起点选择相应路径。

前置条件

你需要：

• 一个 GitHub 账户
• 一个包含文档的仓库（如果没有，我们会创建一个）

选项 1：从入门模板开始

最快的入门方式。入门模板包含示例内容、OpenAPI 规范以及每个组件的示例，方便你在替换为自己的内容前了解其工作方式。

选项 2：连接现有仓库

已经有包含适用于 Jamdesk 的文档的仓库？可以直接连接。如果你要从 Mintlify 或其他文档平台迁移，请先使用选项 3。

选项 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 基础。

本地开发

Jamdesk CLI 允许你在推送到 GitHub 前在本地预览更改。这有助于在 MDX 语法错误影响线上站点前发现问题。有关所有安装方式和命令，请参阅 Jamdesk CLI 概览。

在本地预览更改：

npm install -g jamdesk
cd my-docs
jamdesk dev

打开 **http://localhost:3000**，即可查看启用热重载的文档站点。

添加更多页面

1. 创建一个新的 MDX 文件：

---
title: Getting Started
description: Learn the basics
---

Your content here...

2. 将其添加到 docs.json：

{
  "navigation": {
    "groups": [
      {
        "group": "Getting Started",
        "pages": ["introduction", "getting-started"]
      }
    ]
  }
}

3. 推送到 GitHub，新页面会自动部署。

有关更多链接模式（包括锚点和卡片），请参阅链接与导航。

自定义域名

在 Settings → Domains 中添加自己的域名：

1. 输入域名（例如 docs.example.com）
2. 添加显示的 DNS 记录
3. 等待验证（最长 48 小时）

SSL 证书会自动配置。查看完整指南 →

需要帮助？

遇到问题？浏览帮助中心，查看设置、账单和故障排除指南。也可以联系人工支持：打开任意 Jamdesk 页面底角的聊天窗口，或发送邮件至 support@jamdesk.com。我们会快速回复。

完整参考

你可以构建和运行的所有内容都包含在三份参考中：所有 MDX 组件、所有 CLI 命令以及所有 docs.json 配置选项。

接下来做什么？