LabX Docs

Documentation site powered by MkDocs and the Material theme.

---

Prerequisites

• Python 3.7 or higher installed and accessible via python command
• Basic familiarity with command line / terminal
• (Optional but recommended) Git installed
• (Optional) SSH key setup if you want to clone via SSH

---

Quick Start

1. Clone the repository

git clone https://github.com/ODI-Devs/labx-docs.git
cd labx-docs

Or using SSH:

git clone git@github.com:ODI-Devs/labx-docs.git
cd labx-docs

2. Setup & activate virtual environment (recommended)

python -m venv venv

Activate Virtual Environment

• macOS/Linux:

source venv/bin/activate

• Windows PowerShell

.\venv\Scripts\Activate.ps1

• Windows CMD

.\venv\Scripts\Activate

Note: If you get an execution policy error on Windows, run PowerShell as admin and execute:

Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass

3. Install dependencies

pip install mkdocs mkdocs-material

Check Installation

mkdocs --version

4. Serve the site locally

Start the MkDocs development server:

mkdocs serve

You should see output like:

Serving on http://127.0.0.1:8000/

5. Project Structure

labx-docs/

├── docs/
│   ├── index.md
│   └── other-pages.md
├── mkdocs.yml

• docs/: contains Markdown files
• mkdocs.yml: the main configuration file

6. Deployed Site

• Click : https://odi-devs.github.io/labx-docs/

LabX Team