https://github.com/eikek/publet-plantuml

PlantUML extensio for publet.
https://github.com/eikek/publet-plantuml

Last synced: 14 days ago
JSON representation

PlantUML extensio for publet.

• Host: GitHub
• URL: https://github.com/eikek/publet-plantuml
• Owner: eikek
• Created: 2013-04-06T13:07:16.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2013-04-06T14:05:39.000Z (over 11 years ago)
• Last Synced: 2023-03-12T07:48:13.589Z (over 1 year ago)
• Language: Scala
• Size: 117 KB
• Stars: 2
• Watchers: 0
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## PlantUML Extension

This extension for [publet](https://eknet.org/main/projects/publet/) adds

a [plantuml](http://plantuml.sourceforge.net/) macro to markdown. It translates

your plantuml diagrams to images.

### Prerequisites

PlantUML uses [Graphviz](http://www.graphviz.org/) for rendering some diagrams. Please see

plantuml's documentation site [here](http://plantuml.sourceforge.net/graphvizdot.html).

You should install graphviz on your system. For example, with Debian:


apt-get install graphviz



### Usage

Use plantuml diagrams in your markdown files:

    @startuml

    Alice -> Bob: Authentication Request

    Bob --> Alice: Authentication Response

    @enduml

results in







Everything between the known `@startuml` / `@enduml` is handed to plantuml. The image is

stored in the local filesystem and the code is replaced by the corresponding html image tag.

The image files are reused and recreated only, if the source changes.

### Escaping

To escape from generating images from plantuml sources, use `@startuml:` (just append a

colon). In this case the source code is rendered as is -- without the colon.

You can wrap it in a `
` element easily by appending two colons -- `@startuml::`.


### Configuration

The extension caches the created images in a temporary directory on the server. To avoid

endless growth, it is restricted by default to a maximum size of 50 MiB. You can change

this limit in the `publet.properties` configuration file:

    plantuml.maxDiskSize=200MiB

The disk size can be specified as a plain number, in which case the unit Byte is assumed. Otherwise,

one of the following units can be used: `Bytes`, `KiB`, `MiB`, and `GiB`.

If the size limit is reached, files are removed automatically.