tomehq/tome

何を解決するか

Tome は、Markdown および MDX ファイルから美しくプロフェッショナルなドキュメントサイトを素早く作成できるオープンソースのドキュメントプラットフォームです。Mintlify や GitBook などのマネージドドキュメントサービスの代替として、コスト効率が高く、自己ホスティング可能な選択肢を提供し、ベンダー依存を回避しながら、APIリファレンス生成や統合検索といったハイエンド機能を提供します。

動作方法

開発者は Markdown もしくは MDX（React コンポーネントを含む Markdown）でドキュメントを記述します。Tome はこのコンテンツを静的サイトに変換します。CLI を使ってプロジェクトのスケルトン作成、開発、ビルドが可能。静的出力を Vercel、Netlify、S3 などのプラットフォームに自己ホスティングするか、Tome Cloud を使ってマネージドホスティングを利用できます。

対象ユーザー

バージョン管理をサポートし、OpenAPI仕様からのAPIリファレンスを提供する、セットアップが簡単なプロフェッショナルなドキュメントサイトが必要なソフトウェア開発者や技術ライター。

主な特徴

• AI統合: BYOK を備えた埋め込みAIアシスタントと、AIツール向けの機械可読出力用の MCP サーバーを提供。
• APIリファレンス生成: OpenAPI仕様からインタラクティブなAPIリファレンスページを自動生成。
• コンテンツソース: GitHubリポジトリ、Notionデータベース、カスタムAPIからドキュメントコンテンツを取得可能。
• 開発者体験: 組み込みのコンテンツLint、リンク切れチェック、GitBook や Mintlify からのワンコマンド移行機能。
• カスタマイズ: 完全なCSS制御、複数の組み込みテーマ、カスタムビルドフック用のプラグインシステム。