Information & documentation website for Handy-Http.
https://handy-http.andrewlalis.com/
|
Build and Deploy Documentation Site / build-and-deploy (push) Successful in 25s
Details
|
||
|---|---|---|
| .gitea/workflows | ||
| docs | ||
| .gitignore | ||
| LICENSE | ||
| README.md | ||
| ddoc-build.sh | ||
| mkdocs.yml | ||
README.md
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. It uses MkDocs Material for fancy styling.
Setup
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:
mkdocs serve --livereload
To build:
mkdocs build
To (re)build ddocs:
./ddoc-build.sh