https://danpersa.github.io/ascii-diag/

ASCII Diag is a tool that allows you to easily draw beautiful ASCII diagrams in the browser and render them as SVGs
https://danpersa.github.io/ascii-diag/

ascii-diagram diagram diagrams svgs

Last synced: about 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://danpersa.github.io/ascii-diag/
• Owner: danpersa
• License: mit
• Created: 2019-05-02T09:17:28.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T05:16:53.000Z (over 1 year ago)
• Last Synced: 2024-03-29T20:21:50.746Z (3 months ago)
• Topics: ascii-diagram, diagram, diagrams, svgs
• Language: TypeScript
• Homepage:
• Size: 7.1 MB
• Stars: 9
• Watchers: 1
• Forks: 1
• Open Issues: 41
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-ak - ASCII Diag

README

        
# ASCII Diag

[![Build Status](https://travis-ci.org/danpersa/ascii-diag.svg?branch=master)](https://travis-ci.org/danpersa/ascii-diag)



  


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/](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](https://github.com/morgan3d/markdeep), or [ditaa](http://ditaa.sourceforge.net/).

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)