patrickdavey / vimwiki_markdown

A gem to use for converting vimwiki markdown files to html.
MIT License
144 stars 16 forks source link

mermaid support #40

Open patrickdavey opened 2 years ago

patrickdavey commented 2 years ago

https://github.blog/2022-02-14-include-diagrams-markdown-files-mermaid/

Not sure what's involved here. If anyone wants to take a look - great ;)

  graph TD;
      A-->B;
      A-->C;
      B-->D;
      C-->D;
TunnelThruTime commented 8 months ago

I've seen this sort of thing implemented in hugo themes. While the framework behind hugo is the golang, your own work seems to be based on jekyll which is ruby. Maybe the patchwork is already half cemented somewhere else. What do you think would go into building the support?

patrickdavey commented 8 months ago

Not sure, reading the link above -> https://github.blog/2022-02-14-include-diagrams-markdown-files-mermaid/ it talks about an "internal file rendering service" (viewscreen), probably just embedding some ```mermaid tags into your wiki and seeing what it does would be a useful start. Maybe we'd be able to get away with just using whatever HTML is output and embedding the mermaid.js. We don't have to care (like GH does) about whether the source material is dangerous or whatever, because presumably it's the owners own wiki and they know what they're doing.

What makes you say this gem is using jekyll? It's just a collection of cobbled together tools (mainly GH ones) as you can see in the Gemfile