Daily Shaarli

All links of one day in a single page.

August 12, 2023

Open-source tool that uses simple textual descriptions to draw beautiful UML diagrams.


PlantUML is a component that allows you to quickly write:

  • Sequence diagram

    @startuml
    Alice -> Bob: Authentication Request
    Bob --> Alice: Authentication Response
    Alice -> Bob: Another authentication Request
    Alice <-- Bob: Another authentication Response
    @enduml

  • Usecase diagram

  • Class diagram

  • Object diagram

  • Activity diagram (here is the legacy syntax)

  • Component diagram

  • Deployment diagram

  • State diagram

  • Timing diagram

GitHub - plantuml/plantuml: Generate diagrams from textual description
Official Javadoc Documentation: Overview (plantuml 1.2024.7beta2 API)

PlantUMLAsciiDoctor

AsciiDoc Syntax Quick Reference | Asciidoctor Docs

Asciidoctor | A fast, open source text processor and publishing toolchain for converting AsciiDoc content to HTML5, DocBook, PDF, and other formats.

A fast text processor & publishing toolchain for converting AsciiDoc to HTML5, DocBook & more.

AsciiDoc

AsciiDoc is a plain text markup language for writing technical content. It’s packed with semantic elements and equipped with features to modularize and reuse content. AsciiDoc content can be composed using a text editor, managed in a version control system, and published to multiple output formats.

Pandoc - index

If you need to convert files from one markup format into another, pandoc is your swiss-army knife. Pandoc can convert documents in markdown, reStructuredText, textile, HTML, DocBook, LaTeX, MediaWiki markup, TWiki markup, OPML, Emacs Org-Mode, Txt2Tags, Microsoft Word docx, EPUB, or Haddock markup to

HTML formats: XHTML, HTML5, and HTML slide shows using Slidy, reveal.js, Slideous, S5, or DZSlides.
Word processor formats: Microsoft Word docx, OpenOffice/LibreOffice ODT, OpenDocument XML
Ebooks: EPUB version 2 or 3, FictionBook2
Documentation formats: DocBook, GNU TexInfo, Groff man pages, Haddock markup
Page layout formats: InDesign ICML
Outline formats: OPML
TeX formats: LaTeX, ConTeXt, LaTeX Beamer slides
PDF via LaTeX
Lightweight markup formats: Markdown, reStructuredText, AsciiDoc, MediaWiki markup, DokuWiki markup, Emacs Org-Mode, Textile
Custom formats: custom writers can be written in lua.

docToolchain

Create awesome docs the easy way!

docToolchain is a collection of scripts that makes it easy to create and maintain powerful technical documentation. Built on best-of-breed open source technologies, we deliver the best docs toolchain so you don’t have to.

AsciiDoctor