/d2-live

An open-source service to generate image URLs for diagrams based on the provided D2 code. 99.99% Uptime

Primary LanguageGoMIT LicenseMIT

D2-Live

Generate Live Diagram URLs with D2

Publish Status Build Status Uptime License Coverage Status

Aboout

D2-Live is a dynamic tool for creating live, embeddable diagrams using the D2 language.

Key Features and Benefits

  • Effortless Diagram Generation: Convert text to diagrams instantly.
  • Live URLs: Share and embed your diagrams anywhere with live URLs.
  • SVG Output: High-quality, scalable vector graphics ensure your diagrams look sharp at any size.

How to Use D2-Live

  1. Create a Diagram: Start with a text-based diagram in D2 language. Example:
    x: That's got to be the best pirate I've ever seen
    x -> y
    y: So it would seem...
    y -> z: Jack Sparrow's theme starts
    z: Fade into horizon
    
  2. Use D2-Playground: Paste your diagram into d2-playground.
  3. Generate Live URL: Change the URL domain to d2.atlas.lucas.tools. For example, https://d2.atlas.lucas.tools/?script=<encoded_string> gives you an SVG of your diagram.
  4. Embed and Share: The SVG diagram can be embedded and shared anywhere.

Diagram Example

You can use any of the D2-Themes to customize the look of your diagram, just add &theme=<theme_id> to the URL.

Contributing to D2-Live

We welcome contributions! Please refer to our Contribution Guidelines for details on how to submit changes, coding standards, and testing procedures.

License

D2-Live is MIT licensed. For more information, please refer to the LICENSE file.