{"id":47594010,"url":"https://github.com/tomehq/tome","last_synced_at":"2026-04-11T00:02:34.438Z","repository":{"id":343546119,"uuid":"1178155014","full_name":"tomehq/tome","owner":"tomehq","description":"Beautiful documentation that doesn't cost a fortune. Open-source with all of your favorite features.","archived":false,"fork":false,"pushed_at":"2026-03-25T20:43:27.000Z","size":3677,"stargazers_count":338,"open_issues_count":0,"forks_count":19,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-03-26T19:47:56.214Z","etag":null,"topics":["ai","ai-assistance","documentation","html","javascript","markdown","mdx","tom-docs","tome","typescript","vite"],"latest_commit_sha":null,"homepage":"https://tome.center","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tomehq.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-03-10T18:38:26.000Z","updated_at":"2026-03-26T18:57:50.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/tomehq/tome","commit_stats":null,"previous_names":["vxcozy/tome","tomehq/tome"],"tags_count":62,"template":false,"template_full_name":null,"purl":"pkg:github/tomehq/tome","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tomehq%2Ftome","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tomehq%2Ftome/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tomehq%2Ftome/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tomehq%2Ftome/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tomehq","download_url":"https://codeload.github.com/tomehq/tome/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tomehq%2Ftome/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31290625,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-01T13:12:26.723Z","status":"ssl_error","status_checked_at":"2026-04-01T13:12:25.102Z","response_time":53,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","ai-assistance","documentation","html","javascript","markdown","mdx","tom-docs","tome","typescript","vite"],"created_at":"2026-04-01T17:51:11.101Z","updated_at":"2026-04-01T17:51:11.729Z","avatar_url":"https://github.com/tomehq.png","language":"TypeScript","funding_links":[],"categories":["Trending Repos — 19 March 2026"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"./banner.svg\" width=\"100%\" alt=\"Tome — Beautiful documentation that doesn't cost a fortune.\" /\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/tomehq/tome/blob/main/LICENSE\"\u003e\u003cimg src=\"https://img.shields.io/badge/license-MIT-blue.svg\" alt=\"MIT License\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/tomehq/tome/actions\"\u003e\u003cimg src=\"https://github.com/tomehq/tome/actions/workflows/ci.yml/badge.svg\" alt=\"CI\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n---\n\nTome is an open-source documentation platform for developers. Write Markdown, get a beautiful docs site. Self-host for free or deploy to Tome Cloud.\n\n## Quickstart\n\n```bash\nnpx create-tome my-docs\ncd my-docs\nnpm run dev\n```\n\nThat's it. Open [localhost:3000](http://localhost:3000) to see your docs.\n\n## Why Tome?\n\n| | Tome | Mintlify | Docusaurus |\n|---|---|---|---|\n| **Self-host** | Free forever | No | Free |\n| **Managed hosting** | $19/mo | $300+/mo | No |\n| **Unlimited sites** | Yes | $300 each | Manual |\n| **API ref (OpenAPI)** | Built-in | Built-in | Plugin |\n| **Search** | Pagefind + Algolia | Built-in | Algolia |\n| **Setup time** | ~2 min | ~5 min | ~30 min |\n| **Vendor lock-in** | None | Moderate | None |\n\n## Features\n\n- **Markdown \u0026 MDX** — Write docs in Markdown with React components\n- **Syntax highlighting** — Shiki with every language and theme\n- **Built-in search** — Pagefind (local) or Algolia DocSearch\n- **API references** — Auto-generate from OpenAPI specs with interactive playground\n- **Theming** — Full CSS control, dark/light mode, 6 built-in presets\n- **Content sources** — Pull docs from GitHub repos, Notion databases, or custom APIs\n- **Deploy anywhere** — Static output for Vercel, Netlify, S3, or self-host\n- **AI chat** — Embedded AI assistant with BYOK (OpenAI + Anthropic)\n- **MCP server** — Machine-readable output for AI tools\n- **TypeDoc** — Generate API reference pages from TypeScript source\n- **i18n** — Multi-language support with locale directories\n- **Versioning** — Multi-version docs with version switcher\n- **Analytics** — Privacy-first, no cookies, \u003c1KB script\n- **Custom domains** — Full DNS management with SSL\n- **CI/CD auto-deploy** — Scaffolded GitHub Actions workflow, preview deploys on PRs\n- **Migrate from GitBook / Mintlify** — One-command migration with syntax conversion\n- **Redirects** — Config-level and per-page frontmatter redirects\n- **Preview deployments** — Branch-based preview URLs for PR review\n- **Webhooks** — Slack, Discord, and HTTP notifications for deploy events\n- **MDX sandbox** — Build-time AST analysis blocks dangerous JS patterns in MDX\n- **OG images** — Auto-generated social preview cards at build time\n- **Content linting** — Validate heading structure, alt text, paragraph length, and more\n- **Broken link checker** — Catch dead internal links during build\n- **Changelog pages** — Parse Keep a Changelog format with filtering and color coding\n- **Git-based dates** — Auto-display \"Last updated\" from git history\n- **Plugin system** — Extend Tome with custom build hooks and Vite plugins\n\n## CLI\n\n```\ntome init [name]              Scaffold a new docs project (includes CI/CD workflow)\ntome dev                      Start the dev server\ntome build                    Build static site for production\ntome deploy                   Deploy to Tome Cloud\ntome deploy --preview         Deploy a branch preview\ntome migrate gitbook \u003cdir\u003e    Migrate from GitBook\ntome migrate mintlify \u003cdir\u003e   Migrate from Mintlify\ntome lint                     Lint content for common issues\ntome login                    Authenticate with Tome Cloud\ntome typedoc \u003cfiles...\u003e       Generate API docs from TypeScript source\ntome mcp                      Start MCP server for AI tools\ntome algolia:init             Generate Algolia DocSearch config\ntome domains:add              Add a custom domain\ntome domains:remove           Remove a custom domain\ntome domains:list             List configured domains\ntome domains:verify           Check DNS verification status\n```\n\n## Configuration\n\nCreate a `tome.config.js` (or `.ts`) in your project root:\n\n```js\nimport { defineConfig } from \"@tomehq/core\";\n\nexport default defineConfig({\n  name: \"My Docs\",\n  theme: { preset: \"amber\" },\n  search: { provider: \"local\" }, // or \"algolia\"\n  // Optional\n  analytics: { provider: \"plausible\", key: \"your-site-id\" },\n  redirects: [\n    { from: \"/old-page\", to: \"/new-page\" },\n  ],\n  webhooks: [\n    { url: \"https://hooks.slack.com/...\", channel: \"slack\" },\n  ],\n  i18n: { defaultLocale: \"en\", locales: [\"en\", \"ja\"] },\n  versioning: { versions: [\"v1\", \"v2\"], current: \"v2\" },\n});\n```\n\n## Documentation\n\nVisit [tome.center/docs](https://tome.center/docs) for the full documentation.\n\n## Packages\n\n| Package | Description |\n|---|---|\n| [`@tomehq/core`](./packages/core) | Config, routes, markdown processing, deploy, billing, webhooks, linting |\n| [`@tomehq/cli`](./packages/cli) | Command-line interface |\n| [`@tomehq/theme`](./packages/theme) | Default theme with Shell, AiChat, presets |\n| [`@tomehq/components`](./packages/components) | MDX components (Callout, Tabs, Card, Steps, Accordion, API) |\n| [`@tomehq/dashboard`](./packages/dashboard) | Cloud dashboard (projects, billing, settings) |\n| [`@tomehq/landing`](./packages/landing) | Marketing landing page |\n| [`create-tome`](./packages/create-tome) | Project scaffolding (`npx create-tome`) |\n\n## Contributing\n\nSee [CONTRIBUTING.md](./CONTRIBUTING.md) for development setup and guidelines.\n\n## License\n\nMIT © [Tome Contributors](https://github.com/tomehq/tome/graphs/contributors)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftomehq%2Ftome","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftomehq%2Ftome","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftomehq%2Ftome/lists"}