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

Markdown: Diagrams, Graphs, Flowcharts with Mermaid #720

Closed
gsantner opened this issue Oct 5, 2019 · 6 comments · Fixed by #1581
Closed

Markdown: Diagrams, Graphs, Flowcharts with Mermaid #720

gsantner opened this issue Oct 5, 2019 · 6 comments · Fixed by #1581

Comments

@gsantner
Copy link
Owner

gsantner commented Oct 5, 2019

General information

  • App version: v2.1
  • System: v9

Description

This hacktoberfest issue is about adding support for mermaid.js to Markor, which allows to create diagrams via Markdown.

Note that Markor's markdown parser, flexmark also has features for Mermaid. Please have a look at the infos here (flexmark-extensions wiki) and make use of it.
For reference howto integrate Mermaid: previously KaTex was integrated into Markor, it also has javascript&css files bundled via assets and shows in View mode.


grafik


@gsantner gsantner changed the title Markdown: Diagrams, Graphs, Flowcharts with Mermaid in View Markdown: Diagrams, Graphs, Flowcharts with Mermaid Oct 5, 2019
@gsantner gsantner assigned gsantner and jbrezina605 and unassigned gsantner Oct 6, 2019
Repository owner deleted a comment from jbrezina605 Oct 28, 2019
Repository owner deleted a comment from jbrezina605 Oct 28, 2019
Repository owner deleted a comment from jbrezina605 Oct 28, 2019
@gsantner gsantner added this to the Community Contribution milestone Jan 13, 2020
@pschwede
Copy link

pschwede commented Oct 7, 2020

Why not graphviz?

@gsantner
Copy link
Owner Author

gsantner commented Oct 7, 2020

@pschwede
In some markdown appplications I've tried, I've seen Mermaid & probably others which just requires adding some small js/css files. Note: Mermaid is just the first suggestion and probably the most likeley one to be added.

In contrast to that, graphviz is a fat native/c++ based library, that requires NDK and blows up app size, while it's only for a minority of users helpful. Also not have notice graphviz expliciteley somehwere yet.

Does this answer your question?

@ChristianKurz
Copy link

I would also suggest looking into plantuml.

@gsantner
Copy link
Owner Author

gsantner commented Jan 8, 2021

I dont much care which, it needs somebody who works on it /develops it.

So please, if you want it, if you need it - work on it and send a PR.

@HOMMEEN
Copy link

HOMMEEN commented Dec 1, 2021

Does it mean to modify the source code to integrate Mermaid into Markor?

@gsantner
Copy link
Owner Author

gsantner commented Dec 3, 2021

@HOMMEEN
This is part of the issue - to find out how to integrate it and how it works. I don't use mermaid.

Most probably you need to modify source code of Markor for proper integration, yes.

I won't reply additionally to your email, as you have it here.

@fgtham fgtham mentioned this issue Feb 4, 2022
@gsantner gsantner linked a pull request Feb 5, 2022 that will close this issue
gsantner pushed a commit that referenced this issue Feb 5, 2022
…#1581)


The flexmark GitlabExtension already has support for mermaid flowcharts
etc. This change adds the required JavaScript asset. Mermaid graphs can
be added as code of type 'mermaid':


\`\`\`mermaid
flowchart LR
    id1["This is the (text) in the box"]
\`\`\`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants