/d2-docs

Language documentation and blog for D2.

Primary LanguageD2BSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

D2 Documentation

ci daily license

This is language documentation for D2, a modern, open-source text-to-diagram DSL. The source repository for that is here: https://github.com/terrastruct/d2.

Deployed at https://d2lang.com.

Reference

A more formal reference specification is in the works.

Contributing

Development

Init submodules

git submodule update --init

Run dev server

yarn
yarn run dev

Translations

Help wanted for translations.

Current efforts:

  • Korean (Thanks @Baejw0111)

To preview in dev mode: yarn dev --locale ko.

Translations are filed under i18n/ko/docusaurus-plugin-content-docs/current.

Once we have enough docs translated for a certain language (e.g. above 80%), we'll enable the locale switcher on the nav bar for that language.

Note

Diagrams are auto generated by ci/render.sh.

Renders are currently saved as .svg2 because I don't know how to override Docusaurus's SVG loader that uses SVGGo which is causing a bug during compression (removing a class).