Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: Adding mermaid integration for support of more diagrams #1079

Closed
wants to merge 4 commits into from

Conversation

crphang
Copy link
Contributor

@crphang crphang commented Mar 2, 2020

Addresses: #984

WIP, here's an example.

image

Problems that still needs to be addressed before it is usable:

  • Currently I installed mermaid CLI globally to make it work on my own machine. This should generally not be required, we could assess whether we want to this dependency as part of Markbind, because mermaid requires puppeteer which is quite a big dependency.
  • Allow user to pass some critical parameters like height and width
  • Rebase this on Implement an api to ignore text in certain tags #1047 and have it working inline as well.
  • Tests
  • User guide

@damithc
Copy link
Contributor

damithc commented Apr 17, 2020

For the cost/benefit analysis, we can also consider if it brings in enough extra diagrams that plantUML doesn't.

@damithc
Copy link
Contributor

damithc commented Feb 12, 2023

For the cost/benefit analysis, we can also consider if it brings in enough extra diagrams that plantUML doesn't.

I think Mermaid's GitGraph feature https://mermaid.js.org/syntax/gitgraph.html is good enough justification to support it in MarkBind.

@tlylt
Copy link
Contributor

tlylt commented Feb 13, 2023

Closing to consolidate the more recent discussion in #2052

@tlylt tlylt closed this Feb 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants