Appearance
VitePress Deployment Guide
This repository is prepared for VitePress-based GitDocs publishing.
Local development
bash
npm install
npm run docs:devThen open the local URL printed by VitePress.
Production build
bash
npm run docs:build
npm run docs:previewThe generated static site is written to:
text
.vitepress/distCloudflare Pages settings
Use these settings when connecting the repository to Cloudflare Pages:
text
Framework preset: None / VitePress
Build command: npm run docs:build
Build output directory: .vitepress/dist
Root directory: /
Node version: 20 or laterNotes
- Mermaid diagrams are supported through
vitepress-plugin-mermaid. - The founder business-model image is included under
architecture/assets/images/and referenced from Markdown. - The site root is the repository root, so
README.mdacts as the VitePress landing page.
Mermaid diagram rendering
The generated site exposes diagrams through Markdown pages under architecture/diagrams/. Each preview page contains a fenced mermaid block and links to its editable .mmd source. The VitePress config uses vitepress-plugin-mermaid for rendering.
Cloudflare Pages build settings:
text
Build command: npm install && npm run docs:build
Build output directory: .vitepress/dist
Node.js version: 20Validation commands:
bash
npm install
npm run docs:dev
npm run docs:build
npm run docs:preview