add dockerfile and update readme

This commit is contained in:
2026-07-09 14:56:44 +02:00
parent 3289ddbdd6
commit 47ef5575a7
3 changed files with 38 additions and 1 deletions
+5
View File
@@ -0,0 +1,5 @@
FROM docker.io/squidfunk/mkdocs-material:9.7
# add some plugins
ADD requirements.txt /requirements.txt
RUN pip install -r /requirements.txt
+19 -1
View File
@@ -4,12 +4,30 @@
## Build Instructions
## Using Docker compose
1. Ensure you have Docker or Podman installed with the correct `compose` command setup
2. Run compose to build and serve the site:
```bash
docker|podman compose up
```
> [!TIP]
> You might have to use `--force-recreate` to ensure that changes in the Dockerfile
> are applied to a new container. Compose will normal use the last running container.
### Using pip (or virtual envs)
1. Install the required dependencies:
```bash
pip install -r requirements.txt
```
2. [Build the website](https://www.mkdocs.org/getting-started/):
```bash
mkdocs serve
```
```
+14
View File
@@ -0,0 +1,14 @@
---
services:
mkdocs:
build: .
# explicitly force live-reloading per https://github.com/squidfunk/mkdocs-material/issues/8478
command: serve --dev-addr=0.0.0.0:8000 --livereload
security_opt:
- no-new-privileges:true
volumes:
- ./:/docs
ports:
- 8000:8000
healthcheck:
test: wget --spider --quiet http://127.0.0.1:8000