terrastruct/d2
D2
This project is a diagram-as-code tool that transforms declarative text scripts into professional visual representations. It functions as a technical documentation generator, allowing users to define nodes, connections, and hierarchical relationships through a domain-specific modeling language that integrates directly into version-controlled developer workflows.
The tool distinguishes itself through a highly modular architecture that decouples diagram definitions from spatial positioning. It features a pluggable layout engine that supports multiple arrangement algorithms, alongside a styling system inspired by web development that enables global theme management and reusable class-based properties. Users can further customize their output with a sketch-like aesthetic, interactive metadata, and the ability to embed rich content such as markdown and code snippets directly into diagrams.
Beyond basic rendering, the system provides comprehensive support for large-scale documentation projects through file modularization, content parameterization, and automated code formatting. It includes a reactive file watcher for live updates and supports a wide range of output formats, including vector graphics, raster images, and terminal-based text diagrams. The tool also facilitates the creation of interactive presentations and sequential animations to illustrate complex technical workflows.
The software is distributed as a command-line utility designed for integration into automated build pipelines and development environments.
Features
- Text-to-Diagram Generators - Transforms structured text descriptions into visual diagrams by interpreting declarative syntax.
- Command Line Interfaces - Provides a command-line interface for executing tasks, integrating with build pipelines, and supporting developer workflows.
- Technical Documentation - Generates professional visual diagrams from structured text scripts to document system architectures.
- Documentation Generators - Creates software architecture models and system maps from version-controlled text files.
- Version-Controlled Documentation - Manages visual documentation as version-controlled text files to ensure consistency across teams.
- Diagramming Engines - Renders visual diagrams from structured text files using a domain-specific language.
- Declarative Visualization Languages - Provides a domain-specific language for defining nodes and connections that render into interactive visual representations.
- Domain Specific Languages - Uses a specialized domain-specific language to define nodes, edges, and hierarchical relationships for diagram generation.
- Graph Layout Engines - Supports pluggable layout engines that decouple diagram definitions from spatial positioning logic.
- Diagramming Tools - Declarative language for generating complex diagrams from text.
- Multi-Format Output Renderers - Translates internal graph models into diverse output formats including vector graphics, raster images, and text diagrams.
- Software Architecture - Provides specialized syntax for creating hierarchical system diagrams to visualize software structures.
- Intermediate Representations - Normalizes input scripts into a unified intermediate graph representation to facilitate consistent cross-format rendering.
- Automatic Diagram Renderers - Converts structured text definitions into plain text visual representations for terminal viewing.
- Plugin Architectures - Supports a plugin architecture to extend core functionality by connecting to external editors and data sources.
- Diagramming Standards - Supports standard notations like class and sequence diagrams for accurate technical system representation.
- Diagram Exporting - Supports export to various standard image and document formats for publishing compatibility.
- Graph Layout Engines - Allows users to switch between different layout algorithms to optimize node and link positioning.
- Diagramming Language Tooling - Offers syntax highlighting, automatic formatting, and real-time error reporting to improve productivity during diagram creation.
- Technical Presentation Tools - Compiles text-based diagram definitions into interactive slide decks for technical presentations.
- Interactive Diagramming Libraries - Enables embedding of interactive metadata like tooltips and hyperlinks within complex diagrams.
- Modularization Utilities - Facilitates large-scale documentation projects by allowing file imports and variable usage.
- Content Embedding Tools - Supports embedding rich content like markdown, code snippets, and images directly into diagram layouts.
- CSS Class-Based Styling - Provides a CSS-inspired class-based system for managing global themes and reusable visual properties in diagrams.
