https://github.com/derlin/docker-compose-viz-mermaid

Generate beautiful visuals from docker-compose files. The mermaid graph can be exported to PNG, SVG, or edited directly in https://mermaid.live.
https://github.com/derlin/docker-compose-viz-mermaid

docker-compose executable kotlin mermaid utility visualization

Last synced: about 2 months ago
JSON representation

Generate beautiful visuals from docker-compose files. The mermaid graph can be exported to PNG, SVG, or edited directly in https://mermaid.live.

• Host: GitHub
• URL: https://github.com/derlin/docker-compose-viz-mermaid
• Owner: derlin
• License: mit
• Created: 2021-09-21T13:02:09.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-09-03T09:24:37.000Z (about 1 year ago)
• Last Synced: 2024-07-10T02:14:57.402Z (3 months ago)
• Topics: docker-compose, executable, kotlin, mermaid, utility, visualization
• Language: Kotlin
• Homepage: https://derlin.github.io/docker-compose-viz-mermaid
• Size: 2.05 MB
• Stars: 31
• Watchers: 3
• Forks: 3
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
[![Documentation](https://img.shields.io/badge/documentation-derlin.io-informational.svg)](https://derlin.github.io/docker-compose-viz-mermaid/)

![main workflow](https://github.com/derlin/docker-compose-viz-mermaid/actions/workflows/main.yaml/badge.svg)

![banner](docs/assets/dcviz-banner.svg)

Generate Mermaid graphs from docker-compose files (in kotlin).

Inspired from https://github.com/pmsipilot/docker-compose-viz.

![productapp example](https://derlin.github.io/docker-compose-viz-mermaid//assets/generated/productpage-default.png)

* [download](https://github.com/derlin/docker-compose-viz-mermaid/releases)

* [Read the docs](https://derlin.github.io/docker-compose-viz-mermaid/)

## Examples

More examples are located in `src/test/resources/examples/full`

and the generated artifacts are located under `docs/assets/generated` for images and `docs/_includes/generated` for text.

## Roadmap

**TODO**

- [ ] add logs in code

- [ ] support networks in docker-compose

- [ ] support extends in docker-compose