Skip to content

Repository files navigation

Silverbullet PlantUML plug

A SilverBullet plug that renders ```plantuml code blocks as inline SVG diagrams. Diagrams can be rendered either through a remote PlantUML server (default) or via a local PlantUML executable.

Installation

Install via SilverBullet's Library Manager:

  1. Open the command palette and run Library: Install.
  2. Paste the URI of this plug's PLUG.md:
https://github.com/confirm/silverbullet-plantuml/blob/main/PLUG.md

The library page is installed at Library/confirm/PlantUML in your space.

Usage

Check the PLUG.md for the configuration & usage of the plug.

Development

Prepare development environment

Install Node.js dependencies via make:

make install

For local development, symlink the repo into your space's library so SilverBullet picks up changes:

mkdir -p ~/myspace/Library/development
ln -s "$PWD" ~/myspace/Library/development/plantuml

To clean the working tree:

make clean

Build

Build the plug via make:

make build

Note

This produces plantuml.plug.js & plantuml.plug.js.map (i.e. make plug-js), and bumps the version (i.e. make bump-version).
SilverBullet syncs the file automatically — run Plugs: Reload in the command palette to reactivate after a rebuild.

About

Silverbullet v2 plug to display PlantUML charts.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages