This document explains how to set up, run, and preview this documentation locally using Git and MkDocs Material, step by step, for beginners.

You need:

• Python 3.8+
• Git
• Internet connection (for first-time installation)

Check Python:

python --version

Git is required to track changes and save your work history.

git --version

If a version number appears, Git is already installed.

macOS

xcode-select --install

or

brew install git

Ubuntu / Debian

sudo apt update sudo apt install git

Windows

• Install Git for Windows
• Use Git Bash as your terminal

Install MkDocs and the Material theme:

python -m pip install mkdocs-material

Verify installation:

mkdocs --version

Navigate to the directory where mkdocs.yml exists.

cd /path/to/your/project

Check files:

ls

You should see:

mkdocs.yml docs/ 

Stage all changes:

git add .

Commit with a meaningful message:

git commit -m "docs: update markdown content"

Start the local server:

mkdocs serve

You should see:

Serving on http://127.0.0.1:8000/ 

Open your browser and go to:

http://127.0.0.1:8000/ 

• Changes update automatically
• Stop the server with Ctrl + C

Happy writing ✨