{"id":13475476,"url":"https://github.com/terrastruct/text-to-diagram-site","last_synced_at":"2025-05-15T18:11:10.486Z","repository":{"id":61993571,"uuid":"541354815","full_name":"terrastruct/text-to-diagram-site","owner":"terrastruct","description":"Compare syntax, layouts, outputs between languages for generating diagrams with text.","archived":false,"fork":false,"pushed_at":"2025-02-12T01:47:36.000Z","size":8509,"stargazers_count":501,"open_issues_count":9,"forks_count":26,"subscribers_count":14,"default_branch":"master","last_synced_at":"2025-05-15T16:19:06.650Z","etag":null,"topics":["diagram","diagrams","dsl","software-architecture","text-to-diagram"],"latest_commit_sha":null,"homepage":"https://text-to-diagram.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/terrastruct.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-09-26T00:50:04.000Z","updated_at":"2025-05-13T18:40:37.000Z","dependencies_parsed_at":"2024-08-26T15:41:20.082Z","dependency_job_id":"a159f8d5-c139-4c3f-aef6-c35a1d3be8d2","html_url":"https://github.com/terrastruct/text-to-diagram-site","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terrastruct%2Ftext-to-diagram-site","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terrastruct%2Ftext-to-diagram-site/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terrastruct%2Ftext-to-diagram-site/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terrastruct%2Ftext-to-diagram-site/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/terrastruct","download_url":"https://codeload.github.com/terrastruct/text-to-diagram-site/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254394724,"owners_count":22063984,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["diagram","diagrams","dsl","software-architecture","text-to-diagram"],"created_at":"2024-07-31T16:01:20.751Z","updated_at":"2025-05-15T18:11:10.455Z","avatar_url":"https://github.com/terrastruct.png","language":"TypeScript","funding_links":[],"categories":["TypeScript","others"],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003cimg\n  src=\"https://github.com/terrastruct/text-to-diagram.com/blob/6e91e491a0ac913b1ac8b9f710d520cdee903057/public/svg/switch.svg\"\n  width=\"150px\"\n  height=\"150px\"\n  /\u003e\n  \u003ch1\u003eText to diagram comparisons\u003c/h1\u003e\n  \u003ca href=\"http://text-to-diagram.com\"\u003eGo to comparisons site\u003c/a\u003e\n  \u003cp\u003eCompare syntax, layouts, outputs between languages for generating diagrams with text.\u003c/p\u003e\n\u003c/div\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg 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\"\u003e\n\u003c/p\u003e\n\n[![ci](https://github.com/terrastruct/text-to-diagram-site/actions/workflows/ci.yml/badge.svg)](https://github.com/terrastruct/text-to-diagram-site/actions/workflows/ci.yml)\n[![daily](https://github.com/terrastruct/text-to-diagram-site/actions/workflows/daily.yml/badge.svg)](https://github.com/terrastruct/text-to-diagram-site/actions/workflows/daily.yml)\n[![license](https://img.shields.io/github/license/terrastruct/text-to-diagram-site?color=9cf)](./LICENSE)\n\n*Full disclosure: This is created and maintained by Terrastruct. We created D2, and it's\nin our interest to provide anyone evaluating us with an objective comparison against\nalternatives. The only favor granted to D2 is that it shows up as the first\ncomparison. We welcome contributions. Even ones that make D2 look bad (it'll be motivation\nfor us to patch it!).*\n\n### Currently supported comparisons\n\nHigh-quality comparisons take a lot of work, which will only get more as the number of\nexamples grows. Other than D2, the currently supported set are what seem to be the most\npopular tools for text-to-diagram.\n\n- D2\n- Mermaid\n- GraphViz\n- PlantUML\n\nFor completeness, you may want to also evaluate less popular tools/languages. The best\ncatalog we've found is\n[https://xosh.org/text-to-diagram/](https://xosh.org/text-to-diagram/).\n\n## FAQ\n\n- See [https://text-to-diagram.com#faq](https://text-to-diagram.com#faq)\n\n## Contributing\n\n### Run locally\n\n```sh\n# Only needed first run\ngit submodule update --init --recursive\nyarn\n\nyarn dev\n```\n\n### Adding examples\n\nPlease follow the examples in `src/examples`.\n\n1. Create a folder in `src/examples` with a short name of the example\n1. Add in that folder:\n  - `description.txt` to describe what the example aims to demonstrate.\n  - `render/` for SVG renders\n  - `syntax/` for texts\n  - If there are languages with errors for this example, `error/`\n1. Create the text for as many languages as you can. It's okay if not totally complete. We\nor others can fill.\n1. Run `./ci/render.sh` (with the respective tools installed)\n  - Pre-requisite tools:\n    - `mermaid-cli` (`mmdc`)\n    - `plantuml`\n    - `graphviz` (`dot`)\n    - `d2`\n\n\u003cimg alt=\"CLI render\" src=\"/docs/assets/render.png\" /\u003e\n\n### Adding features\n\nIf you think there's a significant feature that people want to compare against, feel free\nto add a line in `src/components/Features.tsx`.\n\n### Adding languages\n\nIf you wish to add a new language, please fill out as many of the examples and features as\npossible. It's a lot of work, but if there's enough interest in the language, perhaps\nothers will help out.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fterrastruct%2Ftext-to-diagram-site","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fterrastruct%2Ftext-to-diagram-site","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fterrastruct%2Ftext-to-diagram-site/lists"}