Installation¶

A step-by-step guide for getting the Docs-as-Code Starter Kit up and running locally.

Jump To¶

Before you begin, make sure you have:

Clone the repository:

git clone https://github.com/Dom-Caracappa/docs-as-code-starter.git
cd docs-as-code-starter

Create and activate a virtual environment:

python3 -m venv .venv
source .venv/bin/activate

➡️ Open your browser and go to http://127.0.0.1:8000 to view the site locally.

After running mkdocs serve, you should see output similar to:

INFO     -  Documentation built in 0.10 seconds
INFO     -  Serving on http://127.0.0.1:8000/

Common installation issues:

mkdocs: command not found
→ You may be outside your virtual environment. Run:

source .venv/bin/activate

ModuleNotFoundError: No module named 'mkdocs'
→ Run pip install -r requirements.txt again to ensure dependencies are installed.

Using Windows?
Activate your environment with:

.venv\Scripts\activate

Common installation issues and how to resolve them:

You may be outside your virtual environment. Run:

bash source .venv/bin/activate

❌ ModuleNotFoundError: No module named 'mkdocs'

The required packages may not be installed. Run:

pip install -r requirements.txt

🪟 Windows Users

Use the following command to activate your environment:

.venv\Scripts\activate