PlantUML demo

This repo demonstrate how to generate document formating by using markdown⁠^[1] or AsciiDoc⁠^[2] documents that has PlantUML diagrams - upstream repo on Gitlab.com⁠^[3].

PlantUML is a component that allows to quickly write both UML or non-UML diagrams - PlantUML.com

Getting started

Simple sample files

• Markdown: PlantUML.md

• AsciiDoc sections:

  • main: PlantUML.adoc

  • UML Sequence diagram: PlantUML-samples.adoc

  • C4Model diagram: PlantUML-c4model.adoc

Pages

A sample portal is deployed at https://adrianovieira.gitlab.io/plantuml-demo

Tecnologies

• Hugo-0.83+⁠^[4]: A static site generator

• Docsy theme⁠^[5]: A Hugo theme for creating great technical documentation sites

Requirements

• git submodule update: if you wanna give it a try locally

  $ git submodule update --init --recursive
  $ cd portal
  
  $ # before you run the command bellow,
  $ # take a look in pages job on .gitlab-ci.yml to check how to update portal/content
  $ hugo server

AsciiDoc artifacts

Install Asciidoctor

$ [sudo] gem install asciidoctor asciidoctor-diagram asciidoctor-pdf \
                     asciidoctor-diagram-plantuml asciidoctor-epub3

Install GraphViz

$ sudo dnf|apt install -y graphviz

Generate pdf book

$ asciidoctor-pdf PlantUML.adoc \
                  -a sourcedir=../../../../../assets/ \
                  -r asciidoctor-diagram \
                  -D build

Generate epub book

$ asciidoctor-epub3 PlantUML.adoc \
                  -a sourcedir=../../../../../assets/ \
                  -r asciidoctor-diagram \
                  -D build

Open generated files

build
├── PlantUML.epub
└── PlantUML.pdf

---

1. Markdown: https://en.wikipedia.org/wiki/Markdown

2. AsciiDoc: https://en.wikipedia.org/wiki/AsciiDoc

3. PlantUML demo (upstream repo): https://gitlab.com/adrianovieira/plantuml-demo

4. Hugo: https://gohugo.io

5. Docsy: https://www.docsy.dev