docmd erzeugt statisches HTML und eignet sich daher hervorragend für schlanke, reproduzierbare Docker-Container. Je nach Anwendungsfall gibt es zwei unterschiedliche Vorgehensweisen.

Offizielles Docker-Image

Das offizielle Image ermöglicht es Ihnen, Ihre Dokumentation zu bauen und auszuliefern, ohne lokal etwas zu installieren. Es unterstützt mehrere Architekturen (linux/amd64 und linux/arm64).

Schnellstart

# Eine bestimmte Version ziehen (empfohlen — die gewünschte Version einsetzen)
docker pull ghcr.io/docmd-io/docmd:0.8.8

# Dokumentation bauen (mountet lokale Docs und schreibt nach ./site)
docker run -v $(pwd)/docs:/docs -v $(pwd)/site:/site ghcr.io/docmd-io/docmd:0.8.8 build

# Eingebaute Demo-Site ausführen
docker run -p 3000:3000 ghcr.io/docmd-io/docmd:0.8.8

Docker Compose

Verwenden Sie Docker Compose, um Build und Serve in einem einzigen Workflow abzuwickeln:

version: '3.8'
services:
  docs:
    image: ghcr.io/docmd-io/docmd:0.8.8
    command: build
    volumes:
      - ./docs:/docs
      - ./site:/site
      - ./docmd.config.json:/docmd.config.json:ro

  serve:
    image: nginx:alpine
    ports:
      - "8080:80"
    volumes:
      - ./site:/usr/share/nginx/html:ro
    depends_on:
      - docs

Image-Details

Eigenes Arbeitsverzeichnis und Dateieigentum

Das Image ist mit WORKDIR /docs konfiguriert, aber Sie können jeden Pfad im Container einhängen und von dort aus arbeiten. Übergeben Sie -w, um das Arbeitsverzeichnis zu überschreiben, sodass es zu Ihrem Projektlayout passt:

# Aus einem eigenen Arbeitsverzeichnis im Container ausführen
docker run -v $(pwd):/workspace -w /workspace ghcr.io/docmd-io/docmd:0.8.8 init

Der Entrypoint erkennt automatisch die UID:GID des eingehängten Verzeichnisses und führt sich selbst mit dieser Identität aus, bevor ein Befehl gestartet wird. Dateien, die von docmd init, docmd build oder docmd dev geschrieben werden, gehören immer dem richtigen Host-Benutzer — kein -u-Flag erforderlich.

Eigenes Dockerfile (über den Deployer)

Für selbstgehostete Produktion erzeugen Sie mit dem Deployer ein Dockerfile, das auf Ihre Projektkonfiguration zugeschnitten ist:

npx @docmd/core deploy --docker

Dies erzeugt ein Dockerfile mit Multi-Stage-Build:

1. Build-Stage — installiert Ihre exakt festgelegte @docmd/core-Version und führt den Build aus.
2. Serve-Stage — kopiert die Ausgabe in ein minimales nginx:alpine-Image.

Erzeugen Sie Docker- und Nginx-Konfigurationen gemeinsam für ein vollständiges Self-Hosting-Setup:

npx @docmd/core deploy --docker --nginx

Bauen und Ausführen

docker build -t my-docs .
docker run -p 8080:80 my-docs

Ihre Dokumentation ist dann unter http://localhost:8080 erreichbar.