# Handy-Http Website

This repository contains the source code for the Handy-Http website that is
used to showcase the project and provide easy access to documentation.

The website is built using MkDocs, and we develop it in a Python [virtual
environment](https://docs.python.org/3/library/venv.html). It uses MkDocs
Material for fancy styling.

## Setup
```shell
python3 -m venv .env
source .env/bin/activate
pip install mkdocs
pip install mkdocs-material
```

To exit the Python virtual environment, type `deactivate` in your shell.

## Building & Running

To run locally:
```shell
mkdocs serve --livereload
```

To build:
```shell
mkdocs build
```

To (re)build ddocs:
```shell
./ddoc-build.sh
```