https://github.com/sharvil/atom-sequence-diagram

A sequence diagram generator for Atom.
https://github.com/sharvil/atom-sequence-diagram

Last synced: about 2 months ago
JSON representation

A sequence diagram generator for Atom.

• Host: GitHub
• URL: https://github.com/sharvil/atom-sequence-diagram
• Owner: sharvil
• License: other
• Created: 2016-08-28T03:34:00.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2016-08-28T03:42:45.000Z (over 8 years ago)
• Last Synced: 2023-10-20T23:05:07.908Z (about 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 3.91 KB
• Stars: 7
• Watchers: 2
• Forks: 4
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Sequence Diagrams

A simple, textual way to draw sequence diagrams in Atom. Write

out the diagram in any buffer and press `ctrl+s` to see a live

rendering.

![sequence-diagram demo](http://sharvil.nanavati.net/projects/img/sequence-diagram-demo.gif)

## Example

```

# Lines starting with # are comments.

title: Secure food delivery

# We can optionally create aliases for participants so they have

# shorter names.

participant Bob as b

Alice->Bob: Authentication request

# Instead of referring to "Bob" we can use his alias, "b".

note right of b: Thinks about it

Bob->Alice: Authentication response

Alice-->Bob: optional negotiation

Bob-->Alice: negotiation response

note over Alice, Bob: Authentication complete

note left of Alice: Hungry...

Alice->>Bob: Food request

Bob->Bob: Procure food

Bob->>Alice: Food response

note over Alice, Bob: Transaction complete

```