docmd generates static HTML, making it ideal for lightweight, reproducible Docker containers. There are two distinct approaches depending on your use case.

Official Docker Image

The official image lets you build and serve your documentation without installing anything locally. It supports multiple architectures (linux/amd64 and linux/arm64).

Quick Start

# Pull a specific version (recommended — substitute the version you need)
docker pull ghcr.io/docmd-io/docmd:0.8.8

# Build your documentation (mounts local docs and outputs to ./site)
docker run -v $(pwd)/docs:/docs -v $(pwd)/site:/site ghcr.io/docmd-io/docmd:0.8.8 build

# Run the built-in demo site
docker run -p 3000:3000 ghcr.io/docmd-io/docmd:0.8.8

Docker Compose

Use Docker Compose to build and serve in a single workflow:

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

Custom working directory and file ownership

The image is configured with WORKDIR /docs, but you can mount and run from any path inside the container. Pass -w to override the working directory and use a mount path that matches your project layout:

# Run from a custom working directory inside the container
docker run -v $(pwd):/workspace -w /workspace ghcr.io/docmd-io/docmd:0.8.8 init

The entrypoint automatically detects the uid:gid that owns the mounted directory and re-execs as that identity before running any command. Files written by docmd init, docmd build, or docmd dev are always owned by the correct host user — no -u flag required.

Custom Dockerfile (via Deployer)

For production self-hosting, generate a Dockerfile tailored to your project configuration using the Deployer:

npx @docmd/core deploy --docker

This generates a Dockerfile using a multi-stage build:

1. Build stage — installs your exact pinned @docmd/core version and runs the build.
2. Serve stage — copies the output into a minimal nginx:alpine image.

Generate both Docker and Nginx configs together for a complete self-hosted setup:

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

Build and Run

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

Your documentation will be live at http://localhost:8080.