README.md

docker-yard

🐳 Docker container that serves YARD documentation for Ruby applications.

Usage

You may be run this container directly using the docker run command from the root of your project:

docker run --rm -it -p "8808:8808" -v "${PWD}:/app" ghcr.io/cargosense/yard:1.0.0

Alternatively, you may configure this container to run as part of a Docker Compose-driven set of services:

services:
  app:
    # Your application's configuration here.
  yard:
    image: "ghcr.io/cargosense/yard:1.0.0"
    ports:
      - "8808:8808"
    volumes:
      - ".:/app"

Tip

By default, the container runs yard server but you may override this by passing a different command. See yard --help for available options.

License

docker-yard is freely available under the MIT License.