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

📝 Note: This site may or may not be maintained, as we are upgrading the Carch documentation using Starlight Astro in the wiki repository. Please refer to that for now.

I am unsure if I will continue maintaining this site in the future.

---

📚 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 npm

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