Awesome
BPMN-Plugin for Obsidian
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)
- Add a valid
*.bpmn
file to your vault - Add the BPMN diagram to your note:
```bpmn
url: [[my-diagram.bpmn]]
```
Parameter
You can customize the view with the following parameters:
Parameter | Description | Values |
---|---|---|
url | The url of the *.bpmn file (required). | Relative/Absolute path, or as "[[*.bpmn]]" markdown link. |
height | The height of the rendered canvas. | [200..1000] |
opendiagram | Show a link to the *.bpmn file. | True/False |
showzoom | Show the zoom buttons below the canvas. | True/False |
enablepanzoom | Enable pan and zoom. | True/False |
zoom | Set the zoom level. Default is 'fit-viewport'. | 0.0 - 10.0 |
x | Set the x coordinate, if a zoom value is set. | 0 - ... (default: 0) |
y | Set the y coordinate, if a zoom value is set. | 0 - ... (default: 0) |
forcewhitebackground | Force a white background. | True/False |
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
- Go to Community Plugins in your Obsidian Settings and disable Safe Mode
- Click on Browse and search for "BPMN"
- Click install
- Toggle the plugin on in the Community Plugins tab
.. manually from this repo
- Download the latest release
*.zip
file. - Unpack the zip in the
.obsidan/plugins
folder of your obsidian vault
How to dev
- Clone this repo into the plugin folder of a (non-productive) vault (
.obsidian/plugins/
) npm i
npm run dev
- Toggle the plugin on in the Community Plugins tab
Donate
<a href='https://ko-fi.com/joleaf' target='_blank'><img height='35' style='border:0px;height:46px;' src='https://az743702.vo.msecnd.net/cdn/kofi3.png?v=0' border='0' alt='Buy Me a Coffee at ko-fi.com' />