README.md

This is the official documentation site for the Carch, built with Vitepress - available in: 🇺🇸 • 🇳🇵 • 🇮🇳 • 🇨🇳 • 🇪🇸 • 🇦🇪 • 🇫🇷 • 🇰🇷 • 🇩🇪 • 🇷🇺 • 🇯🇵

The docs is using the vitepress-theme-tui theme. Thanks to enzonotario for creating this theme, for the suggestions, and for your contributions.

📚 Build Documentation

Assuming you already installed bun on your system

🛠️ 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

🤝 Contributing

If you somehow want to contribute to Carch Docs, you're more than welcome!

You can contribute by:

• Fixing any mistakes or typos in guides
• Translating the documentation into other languages (this is highly encouraged!)

If you're contributing a new language:

• Check the config.ts file to understand how to add your language.
• Add your translated content inside the appropriate subfolder in the docs directory.

Thanks in advance for your support!