Community-Network-Handbook

A field guide to build community networks from scratch

This directory contains the source documentation for the project. The documentation is built using Zensical, a modern static site generator by the creators of Material for MkDocs.

Prerequisites

• Python 3
• A virtual environment located at .venv

Setup

If you haven't set up the environment yet, you can create the virtual environment and install dependencies:

# From the project root
python3 -m venv .venv
.venv/bin/pip install -r docs/requirements.txt

On Windows PowerShell:

py -m venv .venv
.\.venv\Scripts\pip install -r docs\requirements.txt

Serving Locally

To preview the documentation as you write, serve it locally. The site will automatically refresh when you save changes.

# From the project root
.venv/bin/zensical serve

On Windows PowerShell:

.\.venv\Scripts\zensical.exe serve

Open your browser to http://127.0.0.1:8000/.

Building

To build the static site (output to public/):

# From the project root
.venv/bin/zensical build

On Windows PowerShell:

.\.venv\Scripts\zensical.exe build