9ef3f4cb7b21cd4a853000a2683b82b1ca58d030 - docs

edit index.md via macOS

M /docs/undefined +1 -3

✎ modified paragraph one file per diagram type — push them to see them rendered:

− deleted heading supported diagram types

− deleted paragraph all mermaid.js diagram types work:

✎ modified list item flowchart — nodes, edges, decisions

− deleted list item sequence diagram

− deleted list item class diagram

− deleted list item state diagram

✎ modified list item er — entity relationship diagram

✎ modified list item gantt — project timeline

✎ modified list item pie — pie chart

− deleted list item git graph

− deleted list item mindmap

− deleted list item timeline

− deleted list item and more — anything mermaid.js supports

+ inserted heading demos

+ inserted list item sequence — message passing between participants

+ inserted list item class — class hierarchy with methods and properties

+ inserted list item state — state machine with transitions

+ inserted list item gitgraph — git branch and merge history

+ inserted list item mindmap — hierarchical mind map

✎ modified list item push a .mmd or .mermaid file via git (or save via edit mode)

+ inserted list item if rendering fails (invalid syntax), the source is shown as ...

M /docs/undefined +1 -3


5 unmodified lines
6- the rendered SVG is stored alongside the source, so viewing is instant
7- edit mode uses CodeMirror (same as .ts, .py, etc)
8- supported on both sublimated.com (file viewer) and run.sublimated.com (published sites)
9- inline comments and reactions work on the rendered diagram (SVG is inline DOM)
10- [demo](demo.mmd) — example flowchart, push it to see it rendered
10
12## supported diagram types
11## demos
12
14all [mermaid.js](https://mermaid.js.org/) diagram types work:
13one file per diagram type — push them to see them rendered:
14
16- flowchart / graph
17- sequence diagram
18- class diagram
19- state diagram
20- entity relationship diagram
21- gantt chart
22- pie chart
23- git graph
24- mindmap
25- timeline
26- and more — anything mermaid.js supports
15- [flowchart](flowchart.mmd) — nodes, edges, decisions
16- [sequence](sequence.mmd) — message passing between participants
17- [class](class.mmd) — class hierarchy with methods and properties
18- [state](state.mmd) — state machine with transitions
19- [er](er.mmd) — entity relationship diagram
20- [gantt](gantt.mmd) — project timeline
21- [pie](pie.mmd) — pie chart
22- [gitgraph](gitgraph.mmd) — git branch and merge history
23- [mindmap](mindmap.mmd) — hierarchical mind map
24
25## how it works
26
301. push a `.mmd` or `.mermaid` file via git
271. push a `.mmd` or `.mermaid` file via git (or save via edit mode)
282. sublimated detects the file type and sends it to the mermaid renderer (Selkie, Rust/WASM)
293. the rendered SVG is stored in CAS as a `render_svg` representation
304. when you view the file, the SVG is displayed inline
315. edit via `~edit` opens CodeMirror, save triggers re-render
326. if rendering fails (invalid syntax), the source is shown as highlighted code
33
34## embedding in markdown
35
36mermaid code blocks in markdown files are also rendered:
21 unmodified lines