Generate diagrams from textual description
Go to file
Arnaud Roques 8adfb59f5b chore: restore GPL v2 version 2023-10-04 19:47:57 +02:00
.github chore: add new labels for PR 2023-09-18 10:23:08 +00:00
docs test: add documentation with `TESTING.md` 2023-10-02 19:37:46 +00:00
gradle/wrapper java-20, update to gradle-8.2. 2023-07-08 22:58:42 +02:00
plantuml-asl Add license headers to generated codebases 2023-08-01 13:26:08 +02:00
plantuml-bsd Add license headers to generated codebases 2023-08-01 13:26:08 +02:00
plantuml-epl fix: Adds copy task for graphviz.dat to epl build 2023-09-07 07:46:25 +07:00
plantuml-gplv2 chore: restore GPL v2 version 2023-10-04 19:47:57 +02:00
plantuml-lgpl Add license headers to generated codebases 2023-08-01 13:26:08 +02:00
plantuml-mit Add license headers to generated codebases 2023-08-01 13:26:08 +02:00
skin wip: fix minor issues 2023-08-26 10:59:08 +02:00
src fix: minor issue on nesting packages 2023-10-04 19:11:39 +02:00
stdlib feat: update c4 stdlib to v2.8.0 2023-09-11 19:28:35 +02:00
svg Add support for interactive mouseover/mouseout focus on SVG to focusing on a node and its edges in a complex diagram. This is enabled with !pragma svginteractive. 2022-02-16 13:31:48 -05:00
test test: improve [unit] testing 2023-10-02 19:15:20 +00:00
themes Added monochrome monospaced theme for better shapes control 2023-05-11 18:40:18 +07:00
tools Added script that batch converts SVG and/or PNG files to PlantUml sprites. It was used to generate the Material Sprites from https://github.com/plantuml/plantuml-stdlib/pull/1 2017-12-09 00:38:51 +01:00
.dockerignore Add .dockerignore 2022-09-24 23:01:19 +04:00
.editorconfig Add Dockerfile to .editorconfig 2022-09-24 22:51:28 +04:00
.gitignore ignore vscode files 2023-07-08 22:58:42 +02:00
BUILDING.md chore: explanation about graphviz.dat 2023-09-28 18:59:34 +02:00
CITATION.cff docs: create `CITATION.cff` [no CI] 2023-09-05 13:22:23 +02:00
CONTRIBUTING.md docs: explain how to contribute 2023-03-13 19:25:54 +01:00
CONVENTIONAL_COMMIT.md docs: explain how to contribute 2023-03-13 19:25:54 +01:00
COPYING Add GPLv3 License 2014-11-27 09:59:33 +01:00
Dockerfile 1252: Use eclipse-temurin:17-jre-jammy and generate both amd64 and 2023-01-12 21:09:13 -08:00
README.md Update README.md 2023-09-25 09:26:56 +02:00
SECURITY.md Create SECURITY.md 2022-01-21 17:26:43 +01:00
build.gradle.kts test: add a logger plugin to gradle 2023-10-02 19:30:50 +00:00
build.xml chore: add ANT build script 2023-09-21 18:39:48 +02:00
gradle.properties chore: prepare next development cycle 2023-09-13 21:24:43 +02:00
gradlew add basic gradle files to allow conversion to gradle in future, #47 2022-01-06 03:13:46 +01:00
gradlew.bat add basic gradle files to allow conversion to gradle in future, #47 2022-01-06 03:13:46 +01:00
license.txt Fixed some typos in the license text 2021-09-13 15:04:06 +05:30
manifest.txt Missing manifest file needed for PDF 2021-11-17 18:58:15 +01:00
settings.gradle.kts chore: restore GPL v2 version 2023-10-04 19:47:57 +02:00
sjpp.jar Add license headers to generated codebases 2023-08-01 13:26:08 +02:00

README.md

PlantUML

Generate UML diagrams from textual descriptions.

Discord server GitHub Sponsors GitHub Org's stars GitHub watchers GitHub contributors GitHub forks GitHub all releases

online rate peak

Release (latest by date) Release Date GitHub commits since latest release (by date)

Pre-release (latest by date) Pre-release Date GitHub last commit CI

[!IMPORTANT] PlantUML is not affected by the log4j vulnerability.

About

PlantUML is a component that allows you to create various UML diagrams through simple textual descriptions. From sequence diagrams to deployment diagrams and beyond, PlantUML provides an easy way to create visual representations of complex systems.

Supported Diagram Types

Additional Features

Learn More

For a more detailed overview, visit PlantUML Official Website.

Getting Started

Whether you're looking to use PlantUML as a standalone application or as a component in your own project, getting started is simple. Check out the official PlantUML setup guide for instructions on how to set up PlantUML on your system.

Building from Source

To build PlantUML from source, you'll need to have certain prerequisites installed and follow a series of steps outlined in our build guide. Find detailed instructions in our BUILDING.md file.

Contributing

PlantUML is an open-source project, and we welcome contributions of all kinds. Whether you're helping us fix bugs, improve the docs, or spread the word, we appreciate your support. See our contributing guide for more information on how to get started.

Support and Community

License

PlantUML is licensed under several licenses; you can choose the one that suits you best:

For more information, please refer to the PlantUML license FAQ to help determine which license is appropriate for your use case.