Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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: about 3 hours ago
JSON representation

Language documentation and blog for D2.

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