Skip to content

jmerle/inkdrop-plantuml

Repository files navigation

PlantUML plugin for Inkdrop

Build Status Latest Release Downloads

This plugin makes it possible to add PlantUML diagrams to notes.

Install

ipm install plantuml

Usage

```plantuml
@startuml
autonumber
Bob -> Alice : Authentication Request
Bob <- Alice : Authentication Response
@enduml
```

Will be rendered as:

The plugin has two modes, which can be configured in the plugin's settings:

  • Local (default): diagrams are generated using the PlantUML jar provided by the plugin. Requires Java to be installed and available on your PATH. To be able to generate all diagram types Graphviz needs to be installed separately.
  • Server: diagrams are generated using the PlantUML server located at the server url provided in the plugin's settings.

Changelog

See the GitHub releases for an overview of what changed in each update.

Contributing

All contributions are welcome. Please read the Contributing Guide first as it contains information regarding the tools used by the project and instructions on how to set up a development environment.