Skip to content

Latest commit

 

History

History
82 lines (53 loc) · 1.9 KB

README.md

File metadata and controls

82 lines (53 loc) · 1.9 KB

This is the official documentation site for the Carch, built with VitePress.



github actions build status


📚 Build Documentation

Assuming you already have all the usual Node.js dependencies (e.g., Node.js, NVM, Bun, Npm)

🛠️ Clone Repository

git clone https://github.com/carch-org/docs
cd docs

📦 Initialize with Bun

cd <clone dir>
bun add -D vitepress

🏗️ Build

To generate the static documentation files:

bun run docs:build

👀 Preview

To preview the generated build locally:

bun run docs:preview

Copy the local IP address provided and paste it into your browser to view the documentation.


🔄 Development Build

To see live changes while editing the documentation:

bun run docs:dev