pb33f/printing-press repository overview

⁠printing-press Docker image

printing-press turns OpenAPI contracts into beautiful, fast, portable API documentation for humans and agents.

This image packages the ppress CLI so you can render docs without installing Go, npm, Homebrew, or a local binary.

⁠Images

Images are published to both Docker Hub and GitHub Container Registry:

pb33f/printing-press:latest
ghcr.io/pb33f/printing-press:latest

Release tags are also published alongside latest.

⁠Quick check

docker run --rm pb33f/printing-press:latest version
docker run --rm ghcr.io/pb33f/printing-press:latest version

⁠Render local docs

Mount your current directory into /work and run ppress against a local OpenAPI file:

docker run --rm \
  -v "$PWD:/work" \
  -w /work \
  pb33f/printing-press:latest \
  ./openapi.yaml

The generated documentation is written to ./api-docs by default.

⁠Choose an output directory

docker run --rm \
  -v "$PWD:/work" \
  -w /work \
  pb33f/printing-press:latest \
  --output ./site ./openapi.yaml

⁠Publish-mode output

Use --publish when generating static assets for GitHub Pages, S3, Netlify, Cloudflare Pages, or another static host:

docker run --rm \
  -v "$PWD:/work" \
  -w /work \
  pb33f/printing-press:latest \
  --publish --output ./api-docs ./openapi.yaml

⁠Serve a local preview

Map port 9090 when using --serve:

docker run --rm \
  -p 9090:9090 \
  -v "$PWD:/work" \
  -w /work \
  pb33f/printing-press:latest \
  --serve --host 0.0.0.0 --output ./api-docs ./openapi.yaml

Then open http://127.0.0.1:9090⁠.

⁠Read-only source mounts

If you want the source directory mounted read-only, write generated output to a separate mounted directory:

mkdir -p api-docs

docker run --rm \
  -v "$PWD:/src:ro" \
  -v "$PWD/api-docs:/out" \
  -w /src \
  pb33f/printing-press:latest \
  --output /out ./openapi.yaml

⁠Remote OpenAPI sources

docker run --rm \
  -v "$PWD:/work" \
  -w /work \
  pb33f/printing-press:latest \
  --output ./api-docs https://api.pb33f.io/bootstrap/train-travel

⁠Useful links

• Docker install and usage docs⁠
• Rendering modes⁠
• Generated outputs⁠
• GitHub repository⁠
• Discord⁠

printing-press is a product of Princess Beef Heavy Industries, LLC.