Skip to content

ASCII Diag is a tool that allows you to easily draw beautiful ASCII diagrams in the browser and render them as SVGs

License

Notifications You must be signed in to change notification settings

danpersa/ascii-diag

Repository files navigation

ASCII Diag

Build Status

ASCII Diag is a tool that allows you to easily draw beautiful ASCII diagrams in the browser and render them as SVGs

Key Points

  • Draw ASCII diagrams using the browser
  • Render the diagrams to SVGs

Try it

Follow this link: https://danpersa.github.io/ascii-diag/

Run it locally

Requires NodeJS to be installed

  • git clone https://github.com/danpersa/ascii-diag
  • npm install
  • npm start

History of the project

I started this project as a learning project, in order to improve my TypeScript knowledge.

I got inspired by many projects which are rendering ASCII diagrams, like Markdeep, or ditaa.

On top of what Markdeep is doing I wanted to create an editor as well. And as opposed to ditaa which is a server side solution, I wanted a solution which works in the browser.

Contribution

We encourage everybody to contribute!

Contribution guidelines

  • Before adding new code, create a ticket or pick an existing ticket
  • Look for tickets tagged with "good first issue" to get started
  • Discuss the ticket with the maintainers
  • Follow the clean code principles
  • Write unit tests for each functionality you develop (TDD recommended)

About

ASCII Diag is a tool that allows you to easily draw beautiful ASCII diagrams in the browser and render them as SVGs

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Languages