Skip to content

carch-org/docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

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