---
title: Jamdesk 文档
sidebarTitle: 简介
description: 使用基于 MDX 和 GitHub 的 Jamdesk 创建适合 AI 的文档，并借助内置搜索、分析和主题在数秒内完成部署。
---
> **For AI agents:** the complete documentation index is at [llms.txt](/docs/llms.txt). Append `.md` to any page URL for its markdown version.
Jamdesk 是一款[软件文档工具](https://jamdesk.com)，可根据 Markdown 文件构建文档站点。连接 GitHub 代码库，使用 MDX 编写内容，并在数秒内将站点部署到全球。你无需设置构建流水线，也无需自行运行任何 DevOps。每个站点都会生成 `llms.txt` 文件，以便 AI 工具为你的内容建立索引。
**使用 AI 编写。** 使用 Cursor、Claude 或任何 AI 助手生成和编辑文档。MDX 是一种 AI 工具原生理解的文本格式，因此无需特殊提示词。
## 一个最小化的 Jamdesk 项目
```text
my-docs/
├── docs.json
└── introduction.mdx
```
这就是全部所需内容。请参阅 [快速入门](/cn/quickstart) 创建自己的项目。
在 GitHub 上浏览[本文档的源代码](https://github.com/jamdesk/jamdesk-docs)。这是一个可供参考的可运行 Jamdesk 项目。
## 包含的功能
推送到 GitHub，你的文档就会部署到全球 CDN。无需构建配置或 CI 流水线。
使用 React 组件实现交互元素的标准 Markdown。
从 Jam、Nebula 或 Pulsar 中选择主题，然后覆盖颜色、字体和样式，使其符合你的品牌。
使用 Cmd+K 搜索，自动为你的内容建立索引。
**需要私有文档？** 使用密码保护整个站点，通过 `private: true` 限制单个页面，或在 Enterprise 版中使用 SSO。请参阅[访问控制](/cn/setup/access-control)。
## 工作原理
使用带有可选 React 组件的 Markdown 创建文档。使用你喜欢的编辑器：VS Code、Cursor 或任何纯文本编辑器。Claude 等 AI 工具可以原生生成和编辑 MDX。
提交更改并推送。你无需运行构建命令或维护部署脚本。
Jamdesk 会检测你的推送，构建站点，并将其部署到全球 CDN。你的文档将通过 `your-project.jamdesk.app` 上线。
## 可构建的内容
用户指南、功能文档和帮助中心。清晰的导航可帮助用户快速找到答案。[查看组件 →](/cn/components/overview)
端点文档、语法高亮的代码示例、请求/响应示例以及身份验证指南。[查看 OpenAPI 支持 →](/cn/api-reference/openapi-example)
教程、快速入门和集成指南。分步组件让复杂流程更易于理解。[查看示例 →](/cn/end-to-end-tutorial)
## 更多功能
内置聊天助手可根据你的文档回答访客问题。
AI 代理可通过 Model Context Protocol 查询你的文档。
无需第三方工具即可获取页面浏览量、搜索查询和地理数据。
根据 OpenAPI 3.0+ 规范自动生成 API 页面。
通过 `docs.yourcompany.com` 提供服务，并自动配置 SSL。
自动生成元标签、Open Graph 图片和站点地图。
## 开始使用
在 5 分钟内部署你的第一个文档站点
设置本地开发环境
学习编写文档
探索可用组件