SECTION · 01

关键指标一览

Stars 数

25,044

Forks 数

728

Watchers 数

25,044

Issue 数

550

主要语言

Go

许可证

MPL-2.0

仓库所有者

d2lang

创建时间

2022.09.05

更新时间

2026.08.23

主题标签

开发工具图表绘制图表 Go Go 软件架构文本转图表

SECTION · 03

README 详细介绍

README 原文为英文,如需阅读完整中文内容,建议使用 浏览器翻译插件(如 Edge 浏览器自带翻译、Google 翻译扩展)进行整页翻译。

<div align="center">
<img src="./docs/assets/banner.png" alt="D2" />
<h2>
A modern diagram scripting language that turns text to diagrams.
</h2>

Docs | Cheat sheet | Comparisons | Playground

https://user-images.githubusercontent.com/3120367/206125010-bd1fea8e-248a-43e7-8f85-0bbfca0c6e2a.mp4

</div>

vars: {
  d2-config: {
    layout-engine: elk
    # Terminal theme code
    theme-id: 300
  }
}
network: {
  cell tower: {
    satellites: {
      shape: stored_data
      style.multiple: true
    }

    transmitter

    satellites -> transmitter: send
    satellites -> transmitter: send
    satellites -> transmitter: send
  }

  online portal: {
    ui: {shape: hexagon}
  }

  data processor: {
    storage: {
      shape: cylinder
      style.multiple: true
    }
  }

  cell tower.transmitter -> data processor.storage: phone logs
}

user: {
  shape: person
  width: 130
}

user -> network.cell tower: make call
user -> network.online portal.ui: access {
  style.stroke-dash: 3
}

api server -> network.online portal.ui: display
api server -> logs: persist
logs: {shape: page; style.multiple: true}

network.data processor -> api server

> Open in playground

> For more examples, see ./docs/examples.

Quickstart

The most convenient way to use D2 is to just run it as a CLI executable to
produce SVGs from .d2 files.

# First, install D2
curl -fsSL https://d2lang.com/install.sh | sh -s --

echo 'x -> y -> z' > in.d2
d2 --watch in.d2 out.svg

A browser window will open with out.svg and live-reload on changes to in.d2.

Install

The easiest way to install is with our install script:

curl -fsSL https://d2lang.com/install.sh | sh -s --

You can run the install script with --dry-run to see the commands that will be used
to install without executing them.

Or if you have Go installed you can install from source though you won't get the manpage:

go install github.com/d2lang/d2@latest

You can also install a release from source which will include manpages.
See ./docs/INSTALL.md#source-release.

To uninstall with the install script:

curl -fsSL https://d2lang.com/install.sh | sh -s -- --uninstall

For detailed installation docs, see ./docs/INSTALL.md.
We demonstrate alternative methods and examples for each OS.

As well, the functioning of the install script is described in detail to alleviate any
concern of its use. We recommend using your OS's package manager directly instead for
improved security but the install script is by no means insecure.

D2 as a library

In addition to being a runnable CLI tool, D2 can also be used to produce diagrams from
Go programs.

For examples, see ./docs/examples/lib.

Themes

D2 includes a variety of official themes to style your diagrams beautifully right out of
the box. See ./d2themes to browse the available themes and make or
contribute your own creation.

Fonts

D2 ships with "Source Sans Pro" as the font in renders. If you wish to use a different
one, please see ./d2renderers/d2fonts.

Export file types

D2 currently supports SVG, PNG and PDF exports. More coming soon.

Language tooling

D2 is designed with language tooling in mind. D2's parser can parse multiple errors from a
broken program, has an autoformatter, syntax highlighting, and we have plans for LSP's and
more. Good language tooling is necessary for creating and maintaining large diagrams.

The extensions for VSCode and Vim can be found in the Related section.

Plugins

D2 is designed to be extensible and composable. The plugin system allows you to
change out layout engines and customize the rendering pipeline. Plugins can either be
bundled with the build or separately installed as a standalone binary.

Layout engines*:

Dagro (default, bundled): A native Go port of the

Dagre directed graph layout engine that produces layered/hierarchical layouts. Based
on Graphviz's DOT algorithm.

elk-go (bundled): A native Go port of the ELK

directed graph layout engine, particularly suited for node-link diagrams with an
inherent direction and ports.

TALA (binary): Novel layout engine designed

specifically for software architecture diagrams. Requires separate install, visit the
Github page for more.

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.

Sketch-mode rendering uses rough-go, a native Go
compatibility port of the Rough.js 4.6.6 rendering surface used by D2.

LaTeX labels use mathjax-go, a native Go port of
the MathJax 3.2.2 TeX-to-SVG pipeline.

Comparison

For a comparison against other popular text-to-diagram tools, see
https://text-to-diagram.com.

Contributing

Contributions are welcome! See ./docs/CONTRIBUTING.md.

License

Open sourced under the Mozilla Public License 2.0. See ./LICENSE.txt.

We are constantly working on new plugins, integrations, extensions. Contributions are
welcome in any official or community plugins. If you have somewhere in your workflow that
you want to use D2, feel free to open a discussion. We have limited bandwidth and usually
choose the most high-demand ones to work on. If you make something cool with D2 yourself,
let us know and we'll be happy to include it here!

FAQ

Does D2 collect telemetry?
No, D2 does not use an internet connection after installation, except to check for

version updates from Github periodically.

Does D2 need a browser to run?
No, D2 can run entirely server-side.
What's coming in the next release?
See ./ci/release/changelogs/next.md.
I have a question or need help.
The best way to get help is to ask on D2 Discord
I have a feature request, proposal, or bug report.
Please open up a Github Issue.
I have a private inquiry.
Please reach out at hi@d2lang.com.

Notable open-source projects documenting with D2

Do you have or see an open-source project with .d2 files? Please submit a PR adding to
this selected list of featured projects using D2.

ElasticSearch
Sourcegraph
Temporal
Tauri
Rust GUI framework (78.5k stars)
Intellij
Coder
[UC

Berkeley](https://github.com/ucb-bar/hammer/blob/2b5c04d7b7d9ee3c73575efcd7ee0698bd5bfa88/doc/Hammer-Use/hier.d2)

Coronacheck
Official app of the Netherlands for coronavirus entry passes.
[Block

Protocol](https://github.com/blockprotocol/blockprotocol/blob/db4cf8d422b881e52113aa52467d53115270e2b3/libs/%40blockprotocol/type-system/crate/assets/overview.d2)

The Block Protocol is an open standard for building and using data-driven blocks (1.2k

stars).

Dagger
A programmable CI/CD engine that runs your pipelines in containers (8k stars).
[Ivy

Wallet](https://github.com/Ivy-Apps/ivy-wallet/blob/8062624bfa65175ec143cdc4038de27a84d38b57/assets/calc_algo.d2)

Open-source money manager app for Android (1.1k stars).
LocalStack
Cloud service emulator (46k stars)
Queue Library
Queue is a Golang library for spawning and managing a Goroutine pool

d2 – d2lang

关键指标一览

主题标签

README 详细介绍

Table of Contents

What does D2 look like?

Quickstart

Install

D2 as a library

Themes

Fonts

Export file types

Language tooling

Plugins

Comparison

Contributing

License

Related

Official plugins

Community plugins

Misc

FAQ

Notable open-source projects documenting with D2

返回GitHub项目列表

d2 – d2lang

关键指标一览

主题标签

README 详细介绍

Table of Contents

What does D2 look like?

Quickstart

Install

D2 as a library

Themes

Fonts

Export file types

Language tooling

Plugins

Comparison

Contributing

License

Related

Official plugins

Community plugins

Misc

FAQ

Notable open-source projects documenting with D2

其他开源项目推荐

返回GitHub项目列表