Jamdesk 文档
使用基于 MDX 和 GitHub 的 Jamdesk 创建适合 AI 的文档，并借助内置搜索、分析和主题在数秒内完成部署。
Jamdesk 是一款软件文档工具，可根据 Markdown 文件构建文档站点。连接 GitHub 代码库，使用 MDX 编写内容，并在数秒内将站点部署到全球。你无需设置构建流水线，也无需自行运行任何 DevOps。每个站点都会生成 llms.txt 文件，以便 AI 工具为你的内容建立索引。
使用 AI 编写。 使用 Cursor、Claude 或任何 AI 助手生成和编辑文档。MDX 是一种 AI 工具原生理解的文本格式，因此无需特殊提示词。
一个最小化的 Jamdesk 项目
my-docs/
├── docs.json
└── introduction.mdx这就是全部所需内容。请参阅 快速入门 创建自己的项目。
在 GitHub 上浏览本文档的源代码。这是一个可供参考的可运行 Jamdesk 项目。
包含的功能
需要私有文档？ 使用密码保护整个站点，通过 private: true 限制单个页面，或在 Enterprise 版中使用 SSO。请参阅访问控制。
工作原理
1
使用 MDX 编写使用带有可选 React 组件的 Markdown 创建文档。使用你喜欢的编辑器：VS Code、Cursor 或任何纯文本编辑器。Claude 等 AI 工具可以原生生成和编辑 MDX。
2
推送到 GitHub提交更改并推送。你无需运行构建命令或维护部署脚本。
3
数秒内上线Jamdesk 会检测你的推送，构建站点，并将其部署到全球 CDN。你的文档将通过 your-project.jamdesk.app 上线。
可构建的内容
用户指南、功能文档和帮助中心。清晰的导航可帮助用户快速找到答案。查看组件 →