New! Render PlantUML diagrams directly inside GitHub
with our official browser extension —
No server. No tokens. No tracking. Zero permissions but clipboard. —
Try it out and let us know what you think!
This editor runs entirely in your browser thanks to our JavaScript rendering engine. Edit the code on the left and see the diagram update instantly!
🌱 PlantUML с первого взгляда
🚀 Начало работы
PlantUML - это универсальный инструмент, позволяющий быстро и просто создавать широкий спектр диаграмм.
Используя простой и интуитивно понятный язык, пользователи могут без труда создавать различные типы диаграмм.
Для подробного изучения возможностей и синтаксиса языка обратитесь к Справочному руководству по языку PlantUML.
Если вы новичок в PlantUML, мы рекомендуем начать со страницы быстрого запуска, чтобы быстро освоиться
и начать работать. Если у вас возникнут вопросы, наша страница F.A.Q. является ценным ресурсом.
Кроме того, PlantUML может быть легко интегрирован с множеством других инструментов для улучшения вашего рабочего процесса.
🧩 Поддерживаемые UML-диаграммы
С помощью PlantUML вы можете создавать хорошо структурированные UML-диаграммы, включая, но не ограничиваясь ими:
- Диаграмма последовательности
- Диаграмма случая использования
- Диаграмма классов
- Диаграмма объектов
- Диаграмма деятельности (Найти синтаксис устаревшей версии можно здесь)
- Диаграмма компонентов
- Диаграмма развертывания
- Диаграмма состояний
- Временная диаграмма
📈 Поддерживаемые диаграммы, не относящиеся к UML
Помимо традиционных диаграмм UML, PlantUML также поддерживает создание различных других типов диаграмм, таких как:
- JSON-данные
- Данные YAML
- EBNF-диаграмма
- Диаграмма Regex
- Сетевая диаграмма (nwdiag)
- Макеты пользовательского интерфейса (соль)
- Диаграмма архитекторов
- [Язык спецификаций и описания (SDL)](activity-diagram-beta#sdl)
- Диаграмма Дитаа
- Диаграмма Ганта
- Диаграмма хронологии
- Диаграмма MindMap
- WBS-диаграмма
- Математика с нотацией AsciiMath или JLaTeXMath
- Диаграмма информационной инженерии (IE)
- Диаграмма отношений между сущностями (ER)
- Chart diagram
- Files diagram
WARNING
This translation need to be updated. WARNING
📣 Дополнительные возможности
Повысьте динамичность и информативность ваших диаграмм с помощью этих дополнительных возможностей:
- Гиперссылки и всплывающие подсказки для обеспечения дополнительного контекста и интерактивности
- Богатое форматирование текста, смайлики, Unicode и иконки с Creole для визуально привлекательного представления
- Иконки OpenIconic для улучшенного визуального представления
- Иконки Sprite для добавления пользовательских символов
- Математические выражения AsciiMath для точного математического представления
📥 Форматы ввода
PlantUML позволяет генерировать диаграммы из различных форматов исходных данных:
Вы можете выбрать одну из различных внутренних кодировок:
⚙ Движки компоновки и опции
PlantUML позволяет использовать несколько различных движков компоновки:
- Graphviz — движок по умолчанию. Использует внешнюю программу;
- Smetana. (Используйте
!pragma layout smetanaв файле или-Playout=smetanaв командной строке.) Порт Graphviz на Java. Отличается немного более прямыми стрелками; - VizJs использует JavaScript. (Используйте
-graphvizdot vizjsв командной строке.) Имеет свойство увеличивать расстояние между узлами, что приводит к увеличению диаграммы; - ELK (Eclipse Layout Kernel). (Используйте
!pragma layout elkв файле или-Playout=elkв командной строке.) Поддерживает только ортогональную компоновку и не охватывает всех возможностей.
- Puma — старый и все еще используемый по умолчанию;
- Teoz (Используйте
!pragma teoz trueв файле или-Pteoz=trueв командной строке) — новый движок, обладающий некоторыми уникальными возможностями: привязки(именованные стрелки/сообщения), длительность, вложенные блоки....
Добиться хорошей компоновки с помощью PlantUML иногда бывает непросто. Смотрите PlantUML GraphViz Layout от Марка Джорджа из Университета Отаго для получения дополнительных советов.
WARNING
This translation need to be updated. WARNING
📤 Выходные форматы
Экспорт диаграмм в различные форматы, соответствующие вашим потребностям, включая:
- PNG для удобного обмена изображениями
- SVG для масштабируемой векторной графики
- LaTeX для высококачественного набора текста
- ASCII art (доступно только для диаграмм последовательности) для текстового представления