BPMN

This plugin lets you view BPMN diagrams interactively in your Obsidian notes with an bpmn code-block. Furthermore, a BPMN modeler lets you edit your BPMNs directly in Obsidian. The plugin is based on the bpmn-js library.

NEW Feature: Token Simulation!

How to use (CodeBlock)

1. Add a valid *.bpmn file to your vault
2. Add the BPMN diagram to your note:

```bpmn
url: [[my-diagram.bpmn]]
```

Parameter

You can customize the view with the following parameters:

While typing inside a bpmn code block, Obsidian autocompletes the parameter names (with a short value hint and the full description on hover).

Insert / Edit code block from a popup

You don't have to type the code block manually:

1. Open a markdown note and put the cursor where the diagram should be inserted (or inside an existing bpmn code block to edit it)
2. Run the command "Insert / Edit BPMN code block" from the command palette (it is only enabled while a markdown file is active)
3. Pick the file with Browse... (all *.bpmn files of the vault are listed) and adjust the other parameters
4. Click Insert — the code block is created at the cursor position (or the block the cursor was in gets replaced)

Create a new BPMN

The command "Create BPMN" creates a new *.bpmn file (in the folder of the active file) and opens it in the BPMN modeler. The New BPMN ribbon icon does the same.

Example

How to edit the BPMN

Just open the BPMN file in your obsidian vault and the BPMN will be editable in fullscreen mode.

Features

• Token simulation
• Update properties
• Export SVG

Install

.. automatically in Obsidian

1. Go to Community Plugins in your Obsidian Settings and disable Safe Mode
2. Click on Browse and search for "BPMN"
3. Click install
4. Toggle the plugin on in the Community Plugins tab

How to dev

1. Clone this repo into the plugin folder of a (non-productive) vault (.obsidian/plugins/)
2. npm i
3. npm run dev
4. Toggle the plugin on in the Community Plugins tab

Donate