tomehq/tome
Beautiful documentation that doesn't cost a fortune. Open-source with all of your favorite features.
What it solves
Tome is an open-source documentation platform that allows developers to quickly create beautiful, professional documentation sites from Markdown and MDX files. It aims to provide a cost-effective, self-hostable alternative to managed documentation services like Mintlify or GitBook, eliminating vendor lock-in while offering high-end features like API reference generation and integrated search.
How it works
Developers write their documentation in Markdown or MDX (Markdown with React components). Tome converts this content into a static site. It provides a CLI for scaffolding, development, and building. Users can either self-host the static output on platforms like Vercel, Netlify, or S3, or use Tome Cloud for managed hosting.
Who it’s for
Software developers and technical writers who need a professional documentation site that is easy to set up, supports versioning, and supports API references from OpenAPI specs.
Highlights
- AI Integration: Includes an embedded AI assistant (BYOK) and an MCP server for machine-readable output for AI tools.
- API Reference Generation: Automatically generates interactive API reference pages from OpenAPI specifications.
- Content Sources: Ability to pull documentation content from GitHub repositories, Notion databases, or custom APIs.
- Developer Experience: Built-in content linting, broken link checking, and one-command migration from GitBook or Mintlify.
- Customization: Full CSS control, multiple built-in theme presets, and a plugin system for custom build hooks.
Related
- Project
- Project
- Project
- Project
- Project