mirror of https://github.com/octoleo/plantuml.git synced 2024-11-05 21:17:52 +00:00

Generate diagrams from textual description

Go to file

PlantUML 8b6abb2b8a Update README.md		2023-09-19 22:56:18 +02:00
.github	Adapt workflows to release the differently licensed plantuml lib versions	2023-07-04 10:15:07 +02:00
docs	Add Docker image locatons	2022-09-25 12:15:24 -04: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-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	chore: prepare next development cycle	2023-09-13 21:24:43 +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: first commit for some unit tests of `tim/stdlib` functions	2023-09-17 19:18:35 +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
build.gradle.kts	chore: build only GPL and MIT version for beta	2023-05-17 21:19:43 +02:00
BUILDING.md	Create BUILDING.md	2023-09-19 22:39:30 +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
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
README.md	Update README.md	2023-09-19 22:56:18 +02:00
SECURITY.md	Create SECURITY.md	2022-01-21 17:26:43 +01:00
settings.gradle.kts	Add building differently licensed plantuml versions	2023-07-03 11:23:07 +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.

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

UML Diagrams
- Sequence
- Use case
- Class
- Object
- Activity (beta)
  - Legacy syntax
- Component
- Deployment
- State
- Timing
Non-UML Diagrams
- JSON data
- YAML data
- EBNF
- Regex
- Network (nwdiag)
- UI Mockups (salt)
- Archimate
- SDL
- Ditaa
- Gantt
- MindMap
- WBS
- Mathematical Notations (AsciiMath, JLaTeXMath)
- IE/ER

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.

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.