https://github.com/terrastruct/d2-docs

Language documentation and blog for D2.
https://github.com/terrastruct/d2-docs

diagramming diagrams documentation text-to-diagram

Last synced: 7 months ago
JSON representation

Language documentation and blog for D2.

• Host: GitHub
• URL: https://github.com/terrastruct/d2-docs
• Owner: terrastruct
• License: bsd-3-clause
• Created: 2022-11-07T22:39:40.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2025-02-15T18:30:15.000Z (8 months ago)
• Last Synced: 2025-02-25T10:13:40.839Z (7 months ago)
• Topics: diagramming, diagrams, documentation, text-to-diagram
• Language: D2
• Homepage: https://d2lang.com
• Size: 47.3 MB
• Stars: 262
• Watchers: 3
• Forks: 32
• Open Issues: 42
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# D2 Documentation

[![ci](https://github.com/terrastruct/d2-docs/actions/workflows/ci.yml/badge.svg)](https://github.com/terrastruct/d2-docs/actions/workflows/ci.yml)

[![daily](https://github.com/terrastruct/d2-docs/actions/workflows/daily.yml/badge.svg)](https://github.com/terrastruct/d2-docs/actions/workflows/daily.yml)

[![license](https://img.shields.io/github/license/terrastruct/d2-docs?color=9cf)](./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](https://github.com/terrastruct/d2).

Deployed at [https://d2lang.com](https://d2lang.com).

## Reference

A more formal reference specification is in the works.

## Contributing

### Development

Init submodules

```sh

git submodule update --init

```

Run dev server

```sh

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).