Appearance
Deploy the Manual
The manual is a separate static app in the monorepo:
txt
apps/docsIt builds Markdown into static HTML with VitePress.
Local Development
sh
pnpm dev:docsThe docs dev server runs on:
txt
http://127.0.0.1:5174/Production Build
sh
pnpm build:docsOutput:
txt
apps/docs/.vitepress/distThe build also generates:
sitemap.xmlrobots.txt
Configure the Public URL
Set MIAO_DOCS_URL when building:
sh
MIAO_DOCS_URL=https://docs.example.com pnpm build:docsIf the variable is not set, the manual uses:
txt
https://docs.miao.appCloudflare Pages
Recommended Cloudflare Pages settings:
| Setting | Value |
|---|---|
| Framework preset | None |
| Build command | pnpm build:docs |
| Build output directory | apps/docs/.vitepress/dist |
| Node version | Same as repo, Node 25.x |
After deploy, add the site to Google Search Console and submit:
txt
https://your-docs-domain/sitemap.xml