Skip to content

Deploy the Manual

The manual is a separate static app in the monorepo:

txt
apps/docs

It builds Markdown into static HTML with VitePress.

Local Development

sh
pnpm dev:docs

The docs dev server runs on:

txt
http://127.0.0.1:5174/

Production Build

sh
pnpm build:docs

Output:

txt
apps/docs/.vitepress/dist

The build also generates:

  • sitemap.xml
  • robots.txt

Configure the Public URL

Set MIAO_DOCS_URL when building:

sh
MIAO_DOCS_URL=https://docs.example.com pnpm build:docs

If the variable is not set, the manual uses:

txt
https://docs.miao.app

Cloudflare Pages

Recommended Cloudflare Pages settings:

SettingValue
Framework presetNone
Build commandpnpm build:docs
Build output directoryapps/docs/.vitepress/dist
Node versionSame as repo, Node 25.x

After deploy, add the site to Google Search Console and submit:

txt
https://your-docs-domain/sitemap.xml

Browser DAW user manual