Skip to content

Deploy docs to Cloudflare Pages

The docs site is built with VitePress. Cloudflare Pages hosts it for free, including from private repos.

One-time setup

  1. Go to Cloudflare Dashboard

  2. Click Pages in the sidebar (not Workers), then Create a projectConnect to Git

  3. Authorize with GitHub and select the anatomiq/mimic repo

  4. Under Set up builds and deployments, configure:

    SettingValue
    Project namemimic-docs (or your choice)
    Production branchmain
    Build commandnpm run docs:build
    Build output directorydocs/.vitepress/dist
    Root directory(leave blank)
    Node.js version22
  5. Click Save and Deploy

Cloudflare automatically deploys on every push to main. The first build may take ~2 minutes; subsequent builds are incremental and much faster.

Custom domain (optional)

In the Cloudflare Pages dashboard → your project → Custom domains, add a domain like docs.mimic.dev or point a subdomain.

Preview deployments

Every PR automatically gets a unique preview URL (e.g. abc123.mimic-docs.pages.dev). Cloudflare enables this by default for branch deployments.

Environment variables (not needed)

No secrets or environment variables are required — the site is fully static.