luciano/d2
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

2022-11-12 10:03:32AM

Browse source
This commit is contained in:
Alexander Wang 2022-11-12 10:03:32 -08:00
parent 9b44b84154
commit f1d01cf7f0
1 changed files with 18 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
README.md
View file

@ -136,24 +136,25 @@ more. Good language tooling is necessary for creating and maintaining large diag
The extensions for VSCode and Vim can be found in the [Related](#related) section. The extensions for VSCode and Vim can be found in the [Related](#related) section.
## Layout engine ## Plugins
D2 currently uses the open-source library [dagre](https://github.com/dagrejs/dagre) as its D2 is designed to be extensible and composable. The plugin system allows you to
default layout engine. D2 includes a wrapper around dagre to work around one of its change out layout engines and customize the rendering pipeline. Plugins can either be
biggest limitations -- the inability to make container-to-container edges. bundled with the build or separately installed as a standalone binary.
Dagre was chosen due to its popularity in other tools, but D2 intends to integrate with a **Layout engines**:
variety of layout engines, e.g. `dot`, as well as single-purpose layout types like
sequence diagrams. You can choose whichever layout engine you like and works best for the
diagram you're making.
Terrastruct has created a proprietary layout engine called - [dagre](https://github.com/dagrejs/dagre) (default, bundled): A fast, directed graph
[TALA](https://terrastruct.com/tala). It has been designed specifically for software layout engine that produces layered/hierarchical layouts. Based on Graphviz's DOT
architecture diagrams, though it's good for other domains too. TALA has many advantages algorithm.
over other layout engines, the biggest being that it isn't constrained to hierarchies, or - [ELK](https://github.com/kieler/elkjs) (bundled): A directed graph layout engine
any single type like "radial" or "tree" (as almost all layout engines are). For more particularly suited for node-link diagrams with an inherent direction and ports.
information and to download & try TALA, see - [TALA](https://github.com/terrastruct/TALA) (binary): Novel layout engine designed
[https://github.com/terrastruct/TALA](https://github.com/terrastruct/TALA). specifically for software architecture diagrams.
D2 intends to integrate with a variety of layout engines, e.g. `dot`, as well as
single-purpose layout types like sequence diagrams. You can choose whichever layout engine
you like and works best for the diagram you're making.
## Comparison ## Comparison
@ -189,6 +190,8 @@ Copyright © 2022 Terrastruct, Inc. Open-source licensed under the Mozilla Publi
- Does D2 collect telemetry? - Does D2 collect telemetry?
- No, D2 does not use an internet connection after installation, except to check for - No, D2 does not use an internet connection after installation, except to check for
version updates from Github periodically. version updates from Github periodically.
- Does D2 need a browser to run?
- No, D2 can run entirely server-side.
- I have a question or need help. - I have a question or need help.
- The best way to get help is to open an Issue, so that it's searchable by others in the - The best way to get help is to open an Issue, so that it's searchable by others in the
future. If you prefer synchronous or just want to chat, you can pop into the help future. If you prefer synchronous or just want to chat, you can pop into the help