https://github.com/dstockhammer/docker-plantuml-poetry

Docker image containing the PlantUML CLI and Python+Poetry
https://github.com/dstockhammer/docker-plantuml-poetry

docker mkdocs plantuml poetry python

Last synced: 21 days ago
JSON representation

Docker image containing the PlantUML CLI and Python+Poetry

• Host: GitHub
• URL: https://github.com/dstockhammer/docker-plantuml-poetry
• Owner: dstockhammer
• License: mit
• Created: 2020-07-24T08:43:05.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2025-01-07T19:23:35.000Z (25 days ago)
• Last Synced: 2025-01-07T20:30:39.642Z (25 days ago)
• Topics: docker, mkdocs, plantuml, poetry, python
• Language: Dockerfile
• Homepage: https://hub.docker.com/repository/docker/dstockhammer/plantuml-poetry
• Size: 188 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# docker-plantuml-poetry

Docker image containing the [PlantUML](https://github.com/plantuml/plantuml)

CLI and [Python](https://www.python.org) + [Poetry](https://python-poetry.org).

This is an ideal base image for building [MkDocs](https://github.com/mkdocs/mkdocs)

with the [PlantUML](https://github.com/mikitex70/plantuml-markdown) plugin!

[![Docker Image Version (latest semver)](https://img.shields.io/docker/v/dstockhammer/plantuml-poetry?sort=semver)](https://hub.docker.com/r/dstockhammer/plantuml-poetry)

[![GitHub last commit](https://img.shields.io/github/last-commit/dstockhammer/docker-plantuml-poetry)](https://github.com/dstockhammer/docker-plantuml-poetry/commits/master)

## Usage

Simply create a `Dockerfile` in your project root to build and run your project.

For example, if you're using [MkDocs](https://github.com/mkdocs/mkdocs), the

`Dockerfile` would look something like this:

```dockerfile

FROM dstockhammer/plantuml-poetry

WORKDIR /app

COPY pyproject.toml .

COPY poetry.lock .

RUN poetry install

EXPOSE 8000

ENTRYPOINT [ "poetry", "run", "mkdocs" ]

```

Then build your image:

```sh

docker build -t my-docs .

```

To build the site to `./site` mount the project dir to `/app` and run `build`:

```sh

docker run --rm -v $(pwd):/app my-docs build

```

You can also launch the dev server to get auto reload and everything you would

expect as if the tools were installed locally:

```sh

docker run -p 8000:8000 -v $(pwd):/app -it my-docs serve --dev-addr 0.0.0.0:8000

```