Beautiful documentation that doesn't cost a fortune.

Tome is an open-source documentation platform for developers. Write Markdown, get a beautiful docs site. Self-host for free or deploy to Tome Cloud.

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

That's it. Open localhost:3000 to see your docs.

• Markdown & MDX — Write docs in Markdown with React components
• Syntax highlighting — Shiki with every language and theme
• Built-in search — Pagefind (local) or Algolia DocSearch
• API references — Auto-generate from OpenAPI specs with interactive playground
• Theming — Full CSS control, dark/light mode, 6 built-in presets
• Deploy anywhere — Static output for Vercel, Netlify, S3, or self-host
• AI chat — Embedded AI assistant with BYOK (OpenAI + Anthropic)
• MCP server — Machine-readable output for AI tools
• i18n — Multi-language support with locale directories
• Versioning — Multi-version docs with version switcher
• Analytics — Privacy-first, no cookies, <1KB script
• Custom domains — Full DNS management with SSL
• Preview deployments — Branch-based preview URLs for PR review
• Webhooks — Slack, Discord, and HTTP notifications for deploy events
• OG images — Auto-generated social preview cards at build time
• Content linting — Validate heading structure, alt text, paragraph length, and more
• Broken link checker — Catch dead internal links during build
• Changelog pages — Parse Keep a Changelog format with filtering and color coding
• Git-based dates — Auto-display "Last updated" from git history
• Plugin system — Extend Tome with custom build hooks and Vite plugins

tome init [name]        Scaffold a new docs project
tome dev                Start the dev server
tome build              Build static site for production
tome deploy             Deploy to Tome Cloud
tome deploy --preview   Deploy a branch preview
tome lint               Lint content for common issues
tome login              Authenticate with Tome Cloud
tome mcp                Start MCP server for AI tools
tome algolia:init       Generate Algolia DocSearch config
tome domains:add        Add a custom domain
tome domains:remove     Remove a custom domain
tome domains:list       List configured domains
tome domains:check      Check DNS status

Create a tome.config.js (or .ts) in your project root:

import { defineConfig } from "@tomehq/core";

export default defineConfig({
  name: "My Docs",
  theme: { preset: "amber" },
  search: { provider: "local" },
  // Optional
  webhooks: [
    { url: "https://hooks.slack.com/...", channel: "slack" },
  ],
  analytics: { enabled: true },
  i18n: { defaultLocale: "en", locales: ["en", "ja"] },
  versioning: { versions: ["v1", "v2"], current: "v2" },
});

Visit tome.center/docs for the full documentation.

See CONTRIBUTING.md for development setup and guidelines.

MIT © Tome Contributors