Use yaml syntax

[jgroom33]

The goal of this issue is to implement a data driven approach to the graph.

This approach will allow a structured syntax to handle layouts, layout properties, shapes, shape properties, lines and line properties. Here's an example:

---
graph:
  layout: hierarchical
  properties:
    layout_direction: TD
    edge_weight: 100
    node_spacing: 100
  vertices:
    - name: myCircle
      shape: circle
      color: blue
    - name: myClass
      shape: class
      color: blue
      class_vars:
        - int foo
        - str bar
  edges:
    - A: myCircle
      Z: myClass
      A_end: circle
      Z_end: arrow
      line: dashed
      text: something interesting

mermaid code language would still be used. The above codeblock is using yml to provide syntax highlighting

[jgroom33]

I assume the above syntax would allow this library to grow to handle significantly more complex use cases. It should also provide a more structured use of the underlying libraries that are providing the layout and view capabilities.

tbh, I haven't looked at the codebase though, so I might be completely incorrect. :)

[CamiloTDex]

I would love it

[jgroom33]

here's another repo that could provide some guidance for implementation:
https://github.com/cidrblock/drawthe.net

[CrossEye]

Doesn't this counter the whole point of writing diagrams in a Markdown-like way?

There are many tools out there to help you write diagrams. What sets this one apart, IMHO, is exactly the input format. It's really nice to have Markdown environments in which adding diagrams is simple.

Or are you suggesting something different?

[jgroom33]

I think what sets this tool apart is its inclusion in markdown rendering.
These three types of diagrams are roughly similar:

• ClassDiagram
• Flowchart
• git graph

They could be drawn using the current implementation (DSL) or drawn using a generic implementation (this issue).

This issue would provide development to address the above examples in a generic manner and also address the following issues(not a complete list):
#822 #827 #825 #821 #820 #815 #814 #811 #806 #760 #770 #780

[CrossEye]

I wonder if your goals wouldn't be better met by trying to get some DOT language interpreter embedded in Markdown implementations. That has a less verbose syntax than your proposal (more verbose than Mermaid, of course), but covers a lot more uses of graphs than Mermaid attempts.

Although embedding in Markdown is one of the reasons to use Mermaid, for me it's the ability to write diagrams logically without any nasty fiddling with alignment, box size, or any of the many other details required to use a visual editing program on these.

I've been using such tools when I can since I first saw Alex Moffat's text-diagram -> PNG tool, Sequence, more than 15 years ago, and I still really appreciate them. They have the same rationale for me that Markdown itself does: it's an extremely readable publishing format that can easily be transformed into any number of other formats if desired.

[jgroom33]

I agree that a standardized graph format would be better than the initial recommendation

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.