ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Mermaid

by SublimeText ST3

:tropical_fish: The Sublime Text package for Mermaid diagrams

Details

  • 0.4.0
    0.3.0
  • github.​com
  • github.​com
  • 2 years ago
  • 22 minutes ago
  • 8 years ago

Installs

  • Total 8K
  • Win 3K
  • Mac 4K
  • Linux 1K
Oct 28 Oct 27 Oct 26 Oct 25 Oct 24 Oct 23 Oct 22 Oct 21 Oct 20 Oct 19 Oct 18 Oct 17 Oct 16 Oct 15 Oct 14 Oct 13 Oct 12 Oct 11 Oct 10 Oct 9 Oct 8 Oct 7 Oct 6 Oct 5 Oct 4 Oct 3 Oct 2 Oct 1 Sep 30 Sep 29 Sep 28 Sep 27 Sep 26 Sep 25 Sep 24 Sep 23 Sep 22 Sep 21 Sep 20 Sep 19 Sep 18 Sep 17 Sep 16 Sep 15 Sep 14 Sep 13
Windows 2 4 4 1 1 6 4 3 3 1 1 4 4 2 5 2 0 1 3 4 2 2 1 1 1 1 3 1 2 3 2 1 3 1 5 4 2 0 1 4 2 7 2 0 1 0
Mac 2 6 3 0 6 7 5 8 5 1 2 4 4 3 6 1 1 1 6 3 3 3 3 3 2 3 1 3 4 5 2 0 6 10 3 3 4 2 3 5 4 4 4 3 2 0
Linux 0 2 2 2 0 1 5 2 3 0 0 2 1 2 0 1 0 2 0 1 2 1 1 0 0 1 0 3 1 1 0 0 0 1 0 3 0 0 1 0 2 1 0 2 1 2

Readme

Source
raw.​githubusercontent.​com

Mermaid (for Sublime)


:tropical_fish: The Sublime Text package for Mermaid diagrams.

Install Mermaid from Package Control.

Install Mermaid CLI if you haven't already, and ensure it is on your PATH.

screen-shot

screen-shot

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

screen-shot

screen-shot

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

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.