Create DSL language

[artefactop]

Hi there,

I like diagrams and I want to use it for my company documentation, we create the documentation as Markdown inside /docs folder (we use MkDocs to render it later). The workflow I want to build is the following:

• Developer creates/updates the diagram in /docs/diagrams along with the code changes
• Once is merged to main branch, the CI render that to images and publish to our internal web server

So currently I have to add a previous step of Markdown to web render to build the diagrams images.

Proposal: Would be great to create a DSL language for diagrams. That way, we can create a Markdown plugin for python and included it on MkDocs and render everything in just one step.

Benefits:

• We could add the diagrams inline with the markdown documentation

So we can pass from:

# diagram.py
from diagrams import Diagram
from diagrams.aws.compute import EC2
from diagrams.aws.database import RDS
from diagrams.aws.network import ELB

with Diagram("Web Service", show=False):
    ELB("lb") >> EC2("web") >> RDS("userdb")

To:

diagram "Web Service" {
}

aws.network.elb "lb" {
  diagram = "Web Service"
  link_to = "web"
}

aws.compute.ec2 "web" {
  diagram = "Web Service"
  link_to = "userdb"
}

aws.database.rds "userdb" {
  diagram = "Web Service"
}

• It can be extensible for other languages apart from python (and go-diagrams)
• You don't need to have separate files for diagrams and a pre-render step
• Developers do not need to learn several implementations, for example imagine, ruby, kotlin, etc... developers can work with the same diagram.

A good start point to build the language will be HashiCorp configuration language

[bytehello]

This is a good idea