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 控制、多個內建主題預設，以及用於自訂建置鈎子的外掛系統。