https://github.com/pylover/adia

ASCII diagram language & generator for UML sequence diagram.
https://github.com/pylover/adia

ascii ascii-diagram javascript python

Last synced: 17 days ago
JSON representation

ASCII diagram language & generator for UML sequence diagram.

• Host: GitHub
• URL: https://github.com/pylover/adia
• Owner: pylover
• License: mit
• Created: 2021-06-12T06:44:15.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-11-07T07:52:18.000Z (about 3 years ago)
• Last Synced: 2024-10-13T09:28:18.771Z (about 1 month ago)
• Topics: ascii, ascii-diagram, javascript, python
• Language: Python
• Homepage:
• Size: 41.6 MB
• Stars: 55
• Watchers: 4
• Forks: 5
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

[![PyPI](http://img.shields.io/pypi/v/adia.svg)](https://pypi.python.org/pypi/adia)

[![Build](https://github.com/pylover/adia/actions/workflows/build.yml/badge.svg)](https://github.com/pylover/adia/actions/workflows/build.yml)

[![Coverage Status](https://coveralls.io/repos/github/pylover/adia/badge.svg?branch=master)](https://coveralls.io/github/pylover/adia?branch=master)

[![Python](https://img.shields.io/badge/Python-%3E%3D3.6-blue)](https://python.org)

[![Documentation](https://img.shields.io/badge/Documentation-almost%20done-blue)](https://pylover.github.io/adia/docs/latest/html/)

# ADia

```adia

diagram: Foo

sequence:

foo -> bar: Hello World!

```

Output: 

```

 DIAGRAM: Foo                             

 +-----+             +-----+

 | foo |             | bar |

 +-----+             +-----+

    |                   |

    |~~~Hello World!~~~>|

    |                   |

    |<------------------|

    |                   |

 +-----+             +-----+

 | foo |             | bar |

 +-----+             +-----+

```

[ADia](https://github.com/pylover/adia) is a language specially designed to 

render ASCII diagrams.

Currently, only sequence diagrams are supported, but the roadmap is to support 

two more types of diagrams: `fork` 

[#42](https://github.com/pylover/adia/issues/42) and `class` 

[#41](https://github.com/pylover/adia/issues/41)).

## Get Closer!

- [live demo page](https://pylover.github.io/adia/)

- [documentation](https://pylover.github.io/adia/docs/latest/html/)

The ADia can also run flawlessly inside the browsers using the awesome 

project: [Brython](https://github.com/brython-dev/brython). 

The https://github.com/pylover/adia-live is a good example of how

to use it inside the Javascript. In addition, please read the 

[Javascript API](https://pylover.github.io/adia/docs/latest/html/javascriptapi.html#introduction)

section of the [documentation](https://pylover.github.io/adia/docs/latest/html/).