An open API service indexing awesome lists of open source software.

https://github.com/llaville/graph-plantuml-generator

A PlantUML generator for graph-uml.
https://github.com/llaville/graph-plantuml-generator

graph plantuml uml-class-diagram uml-diagrams

Last synced: 30 days ago
JSON representation

A PlantUML generator for graph-uml.

Awesome Lists containing this project

README

        

# bartlett/graph-plantuml-generator

| Releases | Branch | PHP | Packagist | License | Documentation |
|:--------------|:-------------------------------------------:|:-------------------------------------------------------------:|:---------------------------------------------------------:|:----------------------------------------------:|:----------------------------------------------------------------:|
| Stable v1.4.x | [![Branch 1.4][Branch_14x-img]][Branch_14x] | [![Minimum PHP Version)][PHPVersion_14x-img]][PHPVersion_14x] | [![Stable Version 1.4][Packagist_14x-img]][Packagist_14x] | [![License 1.4][License_14x-img]][License_14x] | [![Documentation 1.4][Documentation_14x-img]][Documentation_14x] |
| Stable v1.5.x | [![Branch 1.5][Branch_15x-img]][Branch_15x] | [![Minimum PHP Version)][PHPVersion_15x-img]][PHPVersion_15x] | [![Stable Version 1.5][Packagist_15x-img]][Packagist_15x] | [![License 1.5][License_15x-img]][License_15x] | [![Documentation 1.5][Documentation_15x-img]][Documentation_15x] |
| Stable v1.6.x | [![Branch 1.6][Branch_16x-img]][Branch_16x] | [![Minimum PHP Version)][PHPVersion_16x-img]][PHPVersion_16x] | [![Stable Version 1.6][Packagist_16x-img]][Packagist_16x] | [![License 1.6][License_16x-img]][License_16x] | [![Documentation 1.6][Documentation_16x-img]][Documentation_16x] |

[Branch_14x-img]: https://img.shields.io/badge/branch-1.4-orange
[Branch_14x]: https://github.com/llaville/graph-plantuml-generator/tree/1.4
[PHPVersion_14x-img]: https://img.shields.io/packagist/php-v/bartlett/graph-plantuml-generator/1.4.0
[PHPVersion_14x]: https://www.php.net/supported-versions.php
[Packagist_14x-img]: https://img.shields.io/badge/packagist-v1.4.0-blue
[Packagist_14x]: https://packagist.org/packages/bartlett/graph-plantuml-generator
[License_14x-img]: https://img.shields.io/packagist/l/bartlett/graph-plantuml-generator
[License_14x]: https://github.com/llaville/graph-plantuml-generator/blob/1.4/LICENSE
[Documentation_14x-img]: https://img.shields.io/badge/documentation-v1.4-green
[Documentation_14x]: https://github.com/llaville/graph-plantuml-generator/tree/1.4/docs

[Branch_15x-img]: https://img.shields.io/badge/branch-1.5-orange
[Branch_15x]: https://github.com/llaville/graph-plantuml-generator/tree/1.5
[PHPVersion_15x-img]: https://img.shields.io/packagist/php-v/bartlett/graph-plantuml-generator/1.5.0
[PHPVersion_15x]: https://www.php.net/supported-versions.php
[Packagist_15x-img]: https://img.shields.io/badge/packagist-v1.5.0-blue
[Packagist_15x]: https://packagist.org/packages/bartlett/graph-plantuml-generator
[License_15x-img]: https://img.shields.io/packagist/l/bartlett/graph-plantuml-generator
[License_15x]: https://github.com/llaville/graph-plantuml-generator/blob/1.5/LICENSE
[Documentation_15x-img]: https://img.shields.io/badge/documentation-v1.5-green
[Documentation_15x]: https://github.com/llaville/graph-plantuml-generator/tree/1.5/docs

[Branch_16x-img]: https://img.shields.io/badge/branch-1.6-orange
[Branch_16x]: https://github.com/llaville/graph-plantuml-generator/tree/1.6
[PHPVersion_16x-img]: https://img.shields.io/packagist/php-v/bartlett/graph-plantuml-generator/1.6.0
[PHPVersion_16x]: https://www.php.net/supported-versions.php
[Packagist_16x-img]: https://img.shields.io/badge/packagist-v1.6.0-blue
[Packagist_16x]: https://packagist.org/packages/bartlett/graph-plantuml-generator
[License_16x-img]: https://img.shields.io/packagist/l/bartlett/graph-plantuml-generator
[License_16x]: https://github.com/llaville/graph-plantuml-generator/blob/1.6/LICENSE
[Documentation_16x-img]: https://img.shields.io/badge/documentation-v1.6-green
[Documentation_16x]: https://github.com/llaville/graph-plantuml-generator/tree/1.6/docs

[![GitHub Discussions](https://img.shields.io/github/discussions/llaville/graph-plantuml-generator)](https://github.com/llaville/graph-plantuml-generator/discussions)
[![Unit Tests](https://github.com/llaville/graph-plantuml-generator/actions/workflows/unit-tests.yaml/badge.svg)](https://github.com/llaville/graph-plantuml-generator/actions/workflows/unit-tests.yaml)
[![GitHub-Pages](https://github.com/llaville/graph-plantuml-generator/actions/workflows/gh-pages.yml/badge.svg)](https://github.com/llaville/graph-plantuml-generator/actions/workflows/gh-pages.yml)

Generate UML diagrams in [PlantUML](https://plantuml.com/) format.

## Documentation

All the documentation is available on [website](https://llaville.github.io/graph-plantuml-generator/1.6),
generated from the [docs](https://github.com/llaville/graph-plantuml-generator/tree/1.6/docs) folder.

* [Getting Started](docs/getting-started.md).

## Resources

* Demo online [PlantUML Server](http://www.plantuml.com/plantuml/uml/).
* Official docker image of [PlantUML Server](https://hub.docker.com/r/plantuml/plantuml-server/) over Jetty or Tomcat.
* [PlantUML Server](https://github.com/plantuml/plantuml-server) is a web application to generate UML diagrams on-the-fly.
* [PlantText](https://www.planttext.com/) is UML online editor.
* [Kroki](https://github.com/yuzutech/kroki) creates diagrams from textual descriptions.
* [Real World PlantUML](https://real-world-plantuml.com/) examples.
* Composer package to provide [PlantUML executable](https://github.com/Jawira/plantuml) and jar.
* [PlantUML Language Reference Guide (pdf)](http://plantuml.com/PlantUML_Language_Reference_Guide.pdf).
* [PlantUML encoding functions for PHP](https://github.com/jawira/plantuml-encoding).
* [Markdown native diagrams with PlantUML](https://blog.anoff.io/2018-07-31-diagrams-with-plantuml/) in GitLab or GitHub.

## Contributors

* Laurent Laville (Lead Developer)