Mermaid
:tropical_fish: The missing Sublime Text 3 package for Mermaid
Details
Installs
- Total 1K
- Win 146
- OS X 1K
- Linux 65
| Sep 19 | Sep 18 | Sep 17 | Sep 16 | Sep 15 | Sep 14 | Sep 13 | Sep 12 | Sep 11 | Sep 10 | Sep 9 | Sep 8 | Sep 7 | Sep 6 | Sep 5 | Sep 4 | Sep 3 | Sep 2 | Sep 1 | Aug 31 | Aug 30 | Aug 29 | Aug 28 | Aug 27 | Aug 26 | Aug 25 | Aug 24 | Aug 23 | Aug 22 | Aug 21 | Aug 20 | Aug 19 | Aug 18 | Aug 17 | Aug 16 | Aug 15 | Aug 14 | Aug 13 | Aug 12 | Aug 11 | Aug 10 | Aug 9 | Aug 8 | Aug 7 | Aug 6 | Aug 5 | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Windows | 1 | 1 | 0 | 1 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 2 | 0 | 2 | 2 | 0 | 0 | 1 | 0 | 2 | 1 | 1 | 1 | 0 | 1 | 1 | 1 | 1 | 1 | 0 | 0 | 0 | 2 | 0 | 1 | 1 | 0 | 1 | 0 | 0 | 0 | 0 | 2 | 2 |
| OS X | 1 | 1 | 0 | 0 | 0 | 1 | 1 | 1 | 0 | 1 | 0 | 1 | 1 | 1 | 1 | 0 | 3 | 2 | 0 | 0 | 1 | 2 | 0 | 0 | 2 | 1 | 0 | 1 | 1 | 0 | 0 | 1 | 2 | 0 | 1 | 1 | 0 | 0 | 2 | 0 | 1 | 1 | 1 | 4 | 1 | 0 |
| Linux | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 2 | 0 | 3 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 |
Readme
- Source
- raw.githubusercontent.com
Mermaid (for Sublime)
:tropical_fish: The missing Sublime Text 3 package for Mermaid.
Install Mermaid from Package Control.
- x[] support, with caveats:
- Inline node definition isn't supported, plus it does not scale well.
styleisn't supported, sinceclass(CSS) support is easier.
Error: language “mermaid” is not supported
graph TB %% tab completion: 'graph'
ID-1[Node 1] %% tab completion: 'node'
ID-2>Node 2]
ID-3(Node 3)
ID-1---ID-2 %% tab completion: 'link'
ID-1 --> ID-3
ID-2--Link between 2 and 3---ID-3
ID-3-->|Action from 3 to 1|ID-1
ID-3 -- "Action from 3 to 2. p/w: '_-!#$%^&*+=?,\'" --> ID-2
%% tab completion: 'class'
classDef blue fill:#08f,stroke:#008
class ID-1 blue
%% tab completion: 'click'
click ID-1 "https://github.com" "Tooltip text"
click ID-2 alert "Tooltip for a callback"
subgraph A subgraph
ID-4{Node 4}
ID-5((fa:fa-spinner))
ID-6["Node 6 (same #quot;shape#quot;)"]
ID-4-.->ID-5
ID-5 -. Action from 5 to 4 .-> ID-4
ID-5==>ID-6
ID-6 == Action from 6 to 5 ==> ID-5
end %% tab completion: 'subgraph'
- x[] support
Error: language “mermaid” is not supported
sequenceDiagram %% tab completion: 'diagram'
%% tab completion: 'participant'
participant A as Alice
participant B as Bob
participant C as Carol
%% tab completion: 'note'
Note left of A: Alice likes to chat
%% tab completion: 'msg'
A->B: Hello Bob, how are you?
loop Healthcheck
B->B: Bob checks himself...
end %% tab completion: 'loop'
Note over B: Bob whispers when sick
alt is sick
B-->A: Not so good :(
else is well
B->A: Feeling fresh like a daisy
end %% tab completion: 'alt'
opt Extra response
B->A: You, Alice?
end %% tab completion: 'opt'
Note right of C: Carol is the boss
C->>A: Get back to work!
loop Every hour
A->>B: Request 1
%% tab completion: 'activate'
activate B
A-x+B: Request 2
B--x-A: Response 2
B-->>A: Response 1
deactivate B
end
[x] Preview in browser
- From the Command Palette:
Mermaid: View In Browser - Defaults to the entire file, unless there is a selection.
- Configurable settings:
quiet_graph_links,theme.
- From the Command Palette:
[x] Exporting, with caveats:
- PNG conversion from SVG conflicts with opening file-URL's, so it's a link.
- Converted SVG may be missing some styling.
[ ] Gantt diagram support
[ ] Windows support
[ ] Linux support
Development:
# Remove package.
$ my_project_path=~/Projects/sublime-mermaid
$ my_packages_path=~/Library/Application\ Support/Sublime\ Text\ 3/Packages
$ ln -s "$my_project_path" "$my_packages_path/Mermaid"
$ cp "$my_project_path/tests/syntax_test_mermaid.mermaid" "$my_packages_path/Default"
# Develop...
$ rm "$my_packages_path/Default/syntax_test_mermaid.mermaid"
$ rm "$my_packages_path/Mermaid"
# Install package.