FlowScript Diagrams
kilrkrow62 downloadsRender ```flow code blocks as inline SVG flowcharts using FlowScript.
- Overview
- Scorecard
- Updates2
Render fenced ```flow code blocks as inline SVG flowcharts inside any Obsidian note, powered by FlowScript.
Usage
Create a fenced code block with the language set to flow:
```flow
#start User Visits Page
Enter Email
#decision Valid?
-> yes: #end Welcome
-> no: Show Error
```
The block renders as an inline SVG diagram in both Live Preview and Reading view.
Syntax
FlowScript uses an indentation-driven DSL. A few key constructs:
| Syntax | Meaning |
|---|---|
#start Label |
Start node (rounded rect) |
#end Label |
End node (rounded rect) |
#decision Label |
Decision diamond |
Plain text |
Process rectangle |
#subprocess, #io, #data, #note |
Additional shapes |
-> yes: Target |
Named branch |
~> Label |
Dashed / retry edge |
#group Name |
Logical grouping |
#lane Name |
Swimlane column |
@direction LR |
Flow direction (TB, BT, LR, RL) |
@theme clean-dark |
Theme override per diagram |
Full syntax reference: kilrkrow/flowscript
Settings
| Setting | Default | Description |
|---|---|---|
| Theme | Clean (light) | Clean (light) or Clean (dark) |
| Transparent background | Off | Removes the diagram background so it blends with your vault theme |
Installation
Manual
- Download
main.js,manifest.json, andstyles.cssfrom the latest release - Copy them to
.obsidian/plugins/flowscript-diagrams/in your vault - Enable FlowScript Diagrams in Settings → Community Plugins
BRAT (beta)
Add kilrkrow/flowscript-for-obsidian in BRAT.
License
HealthExcellent
ReviewPassed
About
Render fenced flow code blocks as inline SVG flowcharts in Live Preview and Reading view using the FlowScript DSL. Use indentation-driven syntax to create start/end nodes, decisions, processes, branches, groups, swimlanes, flow direction and theme overrides, plus optional transparent backgrounds.Details
Current version
0.1.1
Last updated
4 weeks ago
Created
4 weeks ago
Updates
2 releases
Downloads
62
Compatible with
Obsidian 1.0.0+
Platforms
Desktop, Mobile
License
MIT
Author