You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
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:/docs/diagrams
along with the code changesmain
branch, the CI render that to images and publish to our internal web serverSo 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:
So we can pass from:
To:
A good start point to build the language will be HashiCorp configuration language
The text was updated successfully, but these errors were encountered: