MarkBind / markbind

MarkBind is a tool for generating content-heavy websites from source files in Markdown format
https://markbind.org/
MIT License
134 stars 123 forks source link

Strong support for diagrams #984

Open damithc opened 4 years ago

damithc commented 4 years ago

As project documentation is one of our target use cases, we should be able to say we have the best support for diagramming.

crphang commented 4 years ago

Some more diagram support with libraries like https://github.com/mermaid-js/mermaid could help.

Further abstraction the work already done for inline PUML: #968 can allow integration with these diagrams to be done more easily.

ang-zeyu commented 4 years ago

I'm ~almost~ done with the core support for this as mentioned in #968 ( PR https://github.com/MarkBind/markbind/pull/1047 )

but there's still a design decision to be made for the markdown-it patch

Specifically, the standard behaviour of markdown-it is such that something like this dosen't work:

<div>
<script>
alert("hello!")

alert("world")
</script>
</div>

The script ( special ) tags will not work at all, unless

This actually adheres to commonmark spec, hence, do we want to follow this behaviour?

The best user behaviour for any custom tag I have in mind would of course instead be that the special tag works even without a <htmltag> directly on top of it. ( it would work if there is only the empty line between the alerts, but not the <div> before it )

The full list of html blocks ( the <div>s ) that would cause this ( point 6 here )

damithc commented 4 years ago

Adding support for this is useful/feasible? https://visjs.org/

damithc commented 4 months ago

Let's continue to try to integrate Mermaid, as it can bring in a significant value to our diagrams support.

yucheng11122017 commented 2 months ago

Mermaid supported through plugin now :)