Skip to main content
NookDocs
Dashboard

Getting Started

Introduction

NookDocs is a modern documentation platform for teams and APIs.

NookDocs is a documentation platform where the docs live as MDX files in the user's own GitHub repository — repo-first, not a CMS. Every push to the configured branch auto-deploys the changed pages (push-to-deploy). It is LLM-native: each published page is available as raw Markdown at /<page>.md, the whole site is indexed at /llms.txt and /llms-full.txt, and pages can be authored directly by AI tools via the MCP server. Sites are served at {slug}.nookdocs.site or a custom domain.

Why NookDocs?

  • GitHub Sync — Every push deploys. Your docs stay in sync with your code.

  • MDX Components — 30+ built-in components. Callouts, tabs, code groups, API playground — no custom React needed.

  • LLM-First Authoring — Claude, GPT, and Cursor can write docs in the NookDocs format natively. Point your AI at the MCP server or copy a page as Markdown for LLMs.

  • Hybrid Search — Keyword + semantic search powered by Postgres pg_trgm and pgvector. No external index to manage.

  • Custom Domains — docs.yoursite.com with one CNAME. Automatic SSL via Cloudflare for SaaS.

  • API Playground — Auto-generated from OpenAPI specs with a built-in try-it runner.

How it works

  1. Create a project in the dashboard

  2. Connect your GitHub repository

  3. Add MDX files at your docs base (flat layout)

  4. Push — your docs go live instantly

Every push to your configured branch triggers an automatic deployment. Changed files are synced, new pages are added, deleted files are removed.

Tech stack

NookDocs is built with:

  • Next.js 16 — App Router, proxy.ts multi-tenant routing, React 19

  • Supabase — Auth, Postgres, RLS, pgvector + pg_trgm extensions

  • Cloudflare — Custom domains via Cloudflare for SaaS

  • Trigger.dev v4 — Background sync jobs with retries and observability

  • GitHub App + Octokit — Secure repo access without personal tokens

Was this page helpful?

Last updated August 11, 2026