tomehq/tome

解决的问题

Tome 是一个开源文档平台，允许开发者从 Markdown 和 MDX 文件快速创建美观、专业的文档站点。它旨在提供一种成本效益高、可自托管的替代方案，以取代 Mintlify 或 GitBook 等托管文档服务，消除供应商锁定问题，同时提供 API 参考生成和集成搜索等高端功能。

工作原理

开发者使用 Markdown 或 MDX（支持 React 组件的 Markdown）编写文档。Tome 将这些内容转换为静态站点。它提供 CLI 用于项目初始化、开发和构建。用户可以选择将静态输出自托管在 Vercel、Netlify 或 S3 等平台，也可以使用 Tome Cloud 进行托管。

适用人群

需要专业文档站点、易于设置、支持版本控制，并能从 OpenAPI 规范生成 API 参考的软件开发者和技术写作者。

主要亮点

• AI 集成：内置 AI 助手（BYOK）和用于 AI 工具的机器可读输出的 MCP 服务器。
• API 参考生成：从 OpenAPI 规范自动生成交互式 API 参考页面。
• 内容来源：支持从 GitHub 仓库、Notion 数据库或自定义 API 拉取文档内容。
• 开发者体验：内置内容 lint、损坏链接检查，以及从 GitBook 或 Mintlify 一键迁移功能。
• 自定义能力：完全的 CSS 控制、多个内置主题预设，以及用于自定义构建钩子的插件系统。