Awesome

<div align="center"> <img src="https://github.com/terrastruct/text-to-diagram.com/blob/6e91e491a0ac913b1ac8b9f710d520cdee903057/public/svg/switch.svg" width="150px" height="150px" /> <h1>Text to diagram comparisons</h1> <a href="http://text-to-diagram.com">Go to comparisons site</a> <p>Compare syntax, layouts, outputs between languages for generating diagrams with text.</p> </div> <p align="center"> <img align="center" width="754" alt="Screen Shot 2022-10-22 at 3 57 45 PM" src="https://user-images.githubusercontent.com/3120367/197365340-9d4ab821-acd9-4a64-9c9b-035da7f7a6bb.png"> </p>

Full disclosure: This is created and maintained by Terrastruct. We created D2, and it's in our interest to provide anyone evaluating us with an objective comparison against alternatives. The only favor granted to D2 is that it shows up as the first comparison. We welcome contributions. Even ones that make D2 look bad (it'll be motivation for us to patch it!).

Currently supported comparisons

High-quality comparisons take a lot of work, which will only get more as the number of examples grows. Other than D2, the currently supported set are what seem to be the most popular tools for text-to-diagram.

D2
Mermaid
GraphViz
PlantUML

For completeness, you may want to also evaluate less popular tools/languages. The best catalog we've found is https://xosh.org/text-to-diagram/.

FAQ

See https://text-to-diagram.com#faq

Contributing

Run locally

# Only needed first run
git submodule update --init --recursive
yarn

yarn dev

Adding examples

Please follow the examples in src/examples.

Create a folder in src/examples with a short name of the example
Add in that folder:

description.txt to describe what the example aims to demonstrate.
render/ for SVG renders
syntax/ for texts
If there are languages with errors for this example, error/

Create the text for as many languages as you can. It's okay if not totally complete. We or others can fill.
Run ./render.sh (with the respective tools installed)

Pre-requisite tools:
- mmdc
- plantuml
- graphviz
- d2

Adding features

If you think there's a significant feature that people want to compare against, feel free to add a line in src/components/Features.tsx.

Adding languages

If you wish to add a new language, please fill out as many of the examples and features as possible. It's a lot of work, but if there's enough interest in the language, perhaps others will help out.