Set Up Documentation Environment

This document will guide you through setting up the environment for writing Mencrouche documentation.

Environment Setup

Mencrouche documentation is built on VitePress, a static site generator built on Vue and Vite. Please follow the steps below to install the packages and start the documentation site locally:

Install Bun according to the official guide

bash

# Confirm if bun is installed successfully
bun --version

Clone the Mencrouche repository

bash

git clone https://github.com/FOBshippingpoint/mencrouche.git

Install Git Large File Storage according to the official guide (Mencrouche uses Git LFS to store large files, such as videos)
bash
```
git lfs install
git pull
```
Install the required libraries
bash
```
cd mencrouche/docs
bun install
```
Start the local website server
bash
```
bun run --bun --filter=@mencrouche/docs docs:dev --open
```
You should see http://localhost:5173 open in your browser
Try to change the text of the mencrouche/docs/en/index.md file and save it. You can see the text changes on the English homepage without refreshing the page.

Set Up Documentation Environment ​

Environment Setup ​

Set Up Documentation Environment

Environment Setup