Tome is an open-source documentation platform designed to help developers create beautiful, feature-rich documentation sites efficiently. It addresses the common challenge of producing professional-looking documentation without incurring high costs or complex setups. The platform allows users to write content in Markdown or MDX and automatically generates a polished website, offering both free self-hosting and a managed cloud deployment option.

How It Works

Tome functions as a static site generator, processing Markdown and MDX content to build a website. It leverages Shiki for comprehensive syntax highlighting across numerous languages and themes, and integrates Pagefind for efficient local search or Algolia for cloud-based search. A key architectural choice is its built-in support for generating interactive API documentation directly from OpenAPI specifications. The platform emphasizes developer experience with features like AI chat integration, a Machine-Readable Content (MCP) server for AI tools, and streamlined CI/CD workflows.

Quick Start & Requirements

• Primary install / run command:

  npx create-tome my-docs
  cd my-docs
  npm run dev
  

• Non-default prerequisites and dependencies: Node.js is required. No specific hardware, OS, or GPU requirements are mentioned.
• Estimated setup time or resource footprint: Approximately 2 minutes for initial setup.
• Links: Full documentation is available at tome.center/docs.

Highlighted Details

• Supports Markdown and MDX, with built-in syntax highlighting via Shiki and integrated search (Pagefind or Algolia).
• Features automatic API reference generation from OpenAPI specs, an embedded AI chat assistant with BYOK, and an MCP server for AI tool integration.
• Offers extensive customization through theming, dark/light modes, internationalization (i18n), multi-version support, and a plugin system.
• Includes developer-centric tools like content linting, broken link checking, CI/CD auto-deployment scaffolds, and migration utilities for GitBook/Mintlify.

Maintenance & Community

The README mentions contributors but does not list specific individuals or provide links to community channels like Discord or Slack, nor does it detail a public roadmap.

Licensing & Compatibility

Tome is released under the MIT license, which is permissive and generally compatible with commercial use and closed-source linking.

Limitations & Caveats

The provided README does not explicitly list limitations, alpha status, or known bugs. While it highlights extensive features and ease of use, users should evaluate its depth of customization against established alternatives for highly complex documentation structures.