Install Golem directly into your project virtual environment via pip:

# Create and activate an isolated virtual environment
python3 -m venv .venv
source .venv/bin/activate

# Install golem-docs
pip install golem-docs

Verify your installation:

golem --version

To contribute or develop plugins against the latest bleeding-edge commits:

git clone https://github.com/webmaven/golem.git
cd golem
python3 -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"

Golem is self-hosting: it uses itself to build its own documentation site.

The [docs] optional-dependency group declares golem-docs as its own dependency. When installed in editable mode, pip satisfies that self-reference with the editable install already in the environment — no duplicate copy is created.

# Install in editable mode with the docs extra (self-hosting)
pip install -e ".[docs]"

# Build the Golem documentation site
golem build