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

[Feature] Mermaid and graphviz diagrams #47

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

sneakers-the-rat
Copy link
Contributor

Fix: openjournals/joss#1281
Builds on:

Add support for graphviz and mermaid diagrams using https://github.com/pandoc-ext/diagram

  • Vendored lua plugin bc no clean way to include it otherwise and i hate using submodules
  • symlinked to filters directory
  • added to default filters
  • configured to enable/diable diagram engines consistent with security recs in source repo
  • added deps to dockerfile
  • wrote examples in example/paper.md

Works in the tex, html, and jats formats

eg. PDF:

Screenshot 2024-02-28 at 9 05 36 PM Screenshot 2024-02-28 at 9 05 49 PM

Also added an example of how to include a highlighted code block because i thought it was weird we didn't have one

(Again sorry for non-modular PR, couldn't get the code to run otherwise)

@tarleb
Copy link
Collaborator

tarleb commented Apr 30, 2024

Thank you! I'm not sure yet about #45, but the other PRs look good. I'm holding off a little longer, as we should also update the pandoc version in the docker container, which is proving a bit more difficult than expected.

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.

Mermaid diagrams in Markdown-formatted JOSS articles
2 participants