{"id":49897479,"url":"https://github.com/inkloom-io/inkloom","last_synced_at":"2026-05-16T01:01:21.346Z","repository":{"id":343359893,"uuid":"1177310785","full_name":"inkloom-io/inkloom","owner":"inkloom-io","description":"InkLoom is a docs management platform for keeping documentation organized, current, and usable as products evolve.","archived":false,"fork":false,"pushed_at":"2026-03-27T22:28:31.000Z","size":15926,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-14T16:16:57.649Z","etag":null,"topics":["block-editor","devtools","docs","documentation","documentation-as-code","documentation-management","documentation-tool","mdx","open-source","self-hosted","static-site-generator"],"latest_commit_sha":null,"homepage":"https://inkloom.io","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/inkloom-io.png","metadata":{"files":{"readme":"README.md","changelog":null,"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-09T22:52:59.000Z","updated_at":"2026-03-27T22:28:34.000Z","dependencies_parsed_at":null,"dependency_job_id":"1b140248-e1dc-4ded-b8f2-b360c58525aa","html_url":"https://github.com/inkloom-io/inkloom","commit_stats":null,"previous_names":["inkloom-io/inkloom"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/inkloom-io/inkloom","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inkloom-io%2Finkloom","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inkloom-io%2Finkloom/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inkloom-io%2Finkloom/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inkloom-io%2Finkloom/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/inkloom-io","download_url":"https://codeload.github.com/inkloom-io/inkloom/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inkloom-io%2Finkloom/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33086736,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-15T20:25:35.270Z","status":"ssl_error","status_checked_at":"2026-05-15T20:25:34.732Z","response_time":103,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: 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":["block-editor","devtools","docs","documentation","documentation-as-code","documentation-management","documentation-tool","mdx","open-source","self-hosted","static-site-generator"],"created_at":"2026-05-16T01:00:56.536Z","updated_at":"2026-05-16T01:01:21.340Z","avatar_url":"https://github.com/inkloom-io.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cstrong\u003eInkLoom\u003c/strong\u003e\n\u003c/p\u003e\n\n\u003ch1 align=\"center\"\u003eInkLoom\u003c/h1\u003e\n\n\u003ch3 align=\"center\"\u003eA local-first documentation platform — write, review, and publish docs that stay current as your product evolves.\u003c/h3\u003e\n\n\u003cp align=\"center\"\u003e\n  Create, review, and publish documentation with a rich block editor, Git-style version control, and static output you can deploy anywhere.\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"./LICENSE\"\u003e\u003cimg src=\"https://img.shields.io/badge/license-Apache%202.0-blue.svg\" alt=\"License\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://nextjs.org\"\u003e\u003cimg src=\"https://img.shields.io/badge/Next.js-16-black.svg\" alt=\"Next.js 16\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://www.typescriptlang.org\"\u003e\u003cimg src=\"https://img.shields.io/badge/TypeScript-5.4-3178C6.svg\" alt=\"TypeScript\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://www.convex.dev\"\u003e\u003cimg src=\"https://img.shields.io/badge/Convex-Backend-FF6F00.svg\" alt=\"Convex\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://inkloom.dev\"\u003eWebsite\u003c/a\u003e \u0026middot;\n  \u003ca href=\"https://docs.inkloom.dev\"\u003eDocs\u003c/a\u003e \u0026middot;\n  \u003ca href=\"https://inkloom.dev\"\u003eCloud\u003c/a\u003e \u0026middot;\n  \u003ca href=\"https://discord.gg/inkloom\"\u003eDiscord\u003c/a\u003e\n\u003c/p\u003e\n\n---\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\".github/assets/editor-screenshot.png\" alt=\"InkLoom Editor\" width=\"800\" /\u003e\n\u003c/p\u003e\n\n## Why InkLoom exists\n\nDocumentation drifts. Products evolve, APIs change, features get reworked — and the docs quietly fall behind.\n\nMost documentation tools focus on making docs look good. InkLoom focuses on making them stay good — with Git-style version control, structured review workflows, and a build pipeline that treats docs like code you can maintain over time.\n\n## What is InkLoom?\n\nInkLoom is an open-source, local-first documentation platform with a visual block editor, Git-style version control, and static site generation.\n\nIt's designed for teams that want real control over their documentation workflow — drafting, review, conflict resolution, and publishing — without being locked into a hosted platform.\n\nNo authentication required. InkLoom runs as a single-tenant tool backed by [Convex](https://www.convex.dev/).\n\n### Features\n\n| Category | What you get |\n|----------|-------------|\n| **Editor** | BlockNote rich-text editor with 15 custom block types: accordion, callout, card, code block, code group, columns, expandable, frame, iframe, image, LaTeX, response field, steps, tabs, video |\n| **Version control** | Branches, merge requests, diff viewer, conflict resolver, version history |\n| **Comments** | Threaded comments with inline marks |\n| **Theming** | 10 built-in theme presets (Ink, Aurora, Verdant, Ember, Midnight, Dune, Fossil, Vapor, Aubergine, Custom), custom colors/fonts, logo and favicon |\n| **SEO** | OG tags, sitemap.xml, robots.txt, llms.txt |\n| **OpenAPI** | Validate OpenAPI specs and auto-generate API reference pages |\n| **CLI** | `inkloom build`, `inkloom push`, `inkloom pull`, `inkloom export` |\n| **Static output** | Generate a static `dist/` folder deployable to any host |\n| **i18n** | Built-in internationalization with next-intl |\n\n## Status\n\nInkLoom is under active development. Core documentation workflows, version control, static site generation, and theming are stable and in use.\n\n## Quick Start\n\n### Option A: Convex Cloud (Fastest setup)\n\n```bash\nnpx create-inkloom my-docs \u0026\u0026 cd my-docs\n```\n\nOr clone the repo directly:\n\n```bash\ngit clone https://github.com/inkloom/inkloom.git \u0026\u0026 cd inkloom \u0026\u0026 pnpm install\n```\n\n\u003cdetails\u003e\n\u003csummary\u003eConvex offers a generous free tier — more than enough for any documentation project.\u003c/summary\u003e\n\n- **1M** function calls/month\n- **0.5 GB** database + **1 GB** file storage\n- Up to **6 developers** — no credit card required\n\n\u003c/details\u003e\n\n**1. Start the Convex backend** (creates a free account if needed):\n\n```bash\nnpx convex dev\n```\n\n**2. In a new terminal, start the app:**\n\n```bash\npnpm dev\n```\n\nOpen **http://localhost:3000** — no login required.\n\n### Option B: Self-Hosted (Zero external dependencies)\n\nRun everything on your own infrastructure. No account needed, no data leaves your machine.\n\n**1. Scaffold or clone** (same as above).\n\n**2. Start the Convex backend locally:**\n\n```bash\ndocker compose up -d\n```\n\n**3. Generate an admin key:**\n\n```bash\ndocker compose exec backend ./generate_admin_key.sh\n```\n\n**4. Deploy your Convex functions to the local backend:**\n\n```bash\nCONVEX_SELF_HOSTED_URL=http://127.0.0.1:3210 \\\n  CONVEX_SELF_HOSTED_ADMIN_KEY=\u003ckey-from-step-3\u003e \\\n  npx convex dev\n```\n\n**5. Create `.env.local`:**\n\n```env\nNEXT_PUBLIC_CONVEX_URL=http://127.0.0.1:3210\n```\n\n**6. Start the app:**\n\n```bash\npnpm dev\n```\n\nOpen **http://localhost:3000**. The Convex dashboard is available at **http://localhost:6791**.\n\n## Build \u0026 Deploy\n\nGenerate a static site from your docs:\n\n```bash\n# Via CLI\ninkloom build\n\n# Output is in dist/ — deploy to any static host\n```\n\nDeploy the `dist/` folder to Vercel, Netlify, GitHub Pages, Cloudflare Pages, S3, or any static host.\n\n## Hosting the Backend\n\nInkLoom's backend runs on Convex. You have two options:\n\n| | Convex Cloud | Self-Hosted |\n|--|-------------|------------|\n| Setup | `npx convex dev` (2 min) | `docker compose up` (5 min) |\n| Cost | Free tier (generous) | Your infrastructure |\n| Scaling | Automatic | Manual (single-machine default) |\n| Backups | Automatic | You manage |\n| Dashboard | cloud.convex.dev | localhost:6791 |\n\nFor production self-hosting, Convex supports PostgreSQL as a storage backend\n(instead of the default SQLite) for better durability and scalability.\nSee the [Convex self-hosting guide](https://github.com/get-convex/convex-backend/blob/main/self-hosted/README.md) for details.\n\n### Docker: Full-Stack Deployment\n\nTo run both the Convex backend and the InkLoom app in containers:\n\n```bash\ndocker compose -f docker-compose.yml -f docker-compose.app.yml up -d\n```\n\nThis requires a `standalone` Next.js build. Add `output: \"standalone\"` to your `next.config.ts`, then build the Docker image with `docker build -t inkloom .`.\n\n## CLI Reference\n\n| Command | Description |\n|---------|-------------|\n| `inkloom build` | Generate a static site to `dist/` |\n| `inkloom push` | Push local MDX files to a Convex project |\n| `inkloom pull` | Pull pages from Convex as local MDX files |\n| `inkloom export` | Export all project data to `inkloom-export.json` |\n\nInstall the CLI:\n\n```bash\npnpm add -g @inkloom/cli\n```\n\n## Project Structure\n\n```\napps/web/                     # Next.js application\n  app/[locale]/(dashboard)/   # Dashboard routes\n  components/                 # Editor, settings, merge requests, dashboard\n  convex/                     # Convex backend (schema, queries, mutations)\n  lib/                        # Utilities, adapters, site generation\n  hooks/                      # React hooks\n  messages/en.json            # i18n translations\n\npackages/\n  ui/                         # Shared UI component library (@inkloom/ui)\n  mdx-parser/                 # MDX \u003c-\u003e BlockNote conversion (@inkloom/mdx-parser)\n  cli/                        # CLI tool (@inkloom/cli)\n  create-inkloom/             # Project scaffolding (create-inkloom)\n```\n\n## Tech Stack\n\n| Layer | Technology |\n|-------|-----------|\n| Frontend | Next.js 16, React 19, BlockNote editor, Tailwind v4 |\n| Backend | Convex (serverless functions + real-time database) |\n| Build | Static site generation (HTML, CSS, JS) |\n| Monorepo | pnpm workspaces |\n\n## Data Portability\n\nInkLoom stores data in Convex using a portable schema. Export your entire project at any time:\n\n```bash\ninkloom export --output inkloom-export.json\n```\n\nThe export includes all projects, pages, folders, branches, and asset references.\n\n### Upgrade to InkLoom Cloud\n\nWhen you're ready for managed hosting, team collaboration, AI doc generation, GitHub sync, and custom domains:\n\n```bash\ninkloom migrate --to-cloud --file inkloom-export.json\n```\n\nYour data transfers seamlessly to [InkLoom Cloud](https://inkloom.dev) with zero data loss.\n\n## Contributing\n\nWe welcome contributions! InkLoom is maintained by a small team. We review every PR.\n\nSee [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines.\n\n### Development Commands\n\n```bash\npnpm type-check    # Type-check all packages\npnpm build         # Build all packages\npnpm test          # Run all tests\npnpm lint          # Lint all packages\n```\n\n## License\n\nInkLoom is licensed under the [Apache License 2.0](./LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finkloom-io%2Finkloom","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finkloom-io%2Finkloom","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finkloom-io%2Finkloom/lists"}