Skip to content

Commit

Permalink
syntax proposal
Browse files Browse the repository at this point in the history
  • Loading branch information
PiotrJustyna committed May 21, 2024
1 parent 13e28e0 commit e4acca2
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,38 @@ Haskell drakon renderer.

![diagram](./diagram-troubleshooting-on.svg)

## syntax

Proposed input syntax to be converted to diagram images:

```
icon "start" as start
icon "action 1" as action1
icon "end" as end
start > action1
action1 > end
```

This would render something like:

```mermaid
stateDiagram-v2
state "start" as start
state "action 1" as action1
state "end" as end
start --> action1
action1 --> end
```

So two sections:

* icon definitions
* icon connections

But this is subject to change.

## terminology

* title - first step of a diagram
Expand Down

0 comments on commit e4acca2

Please sign in to comment.