Obsidian Stats logoObsidian Stats

BPMN Plugin

by joleaf
5
4
3
2
1
Score: 62/100
Install Code

Description

Category: Note Enhancements
#bpmn#workflow-modeling#diagram-editing

The BPMN Plugin plugin enables users to view and edit BPMN diagrams interactively within Obsidian notes. By using a specialized code block, users can embed BPMN diagrams and customize their display with various parameters such as zoom level, height, and background color. The plugin is powered by the bpmn-js library and supports token simulation, allowing for the dynamic visualization of workflows. Additionally, users can open BPMN files for editing in fullscreen mode and export them as SVGs. This plugin is ideal for those looking to integrate process modeling directly into their Obsidian workspace.

Reviews

No reviews yet.

Stats

34
stars
12,676
downloads
1
forks
1,270
days
114
days
231
days
187
total PRs
5
open PRs
91
closed PRs
91
merged PRs
17
total issues
5
open issues
12
closed issues
169
commits

Latest Version

7.3.3
8 months ago

Changelog

See all version on GitHub

README file from

Github

BPMN-Plugin for Obsidian GitHub tag (latest by date) Release Obsidian Plugin Obsidian downloads

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:

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

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

.. manually from this repo

  1. Download the latest release *.zip file.
  2. Unpack the zip in the .obsidan/plugins folder of your obsidian vault

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

Sponsors