Add mermaid diagrams support through javascript #389
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is the best option that I could find for this. Another way would be to shellout to the `mermaid-cli` but that seems too heavyweight and needs yet another cli to be installed on the machine. Where the pure javascript library is just portable. What this does is that it reverses the highlighting done github API and then it runs the mermaid javascript library on top of the pre tags that are created. The only downside that I can see is that there is now a dependency on the mermaid javascript library in the template. There might be ways to get around this by loading the file dynamically but that seems far too complex for my taste.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is the best option that I could find for this. Another way would be to shellout to the
mermaid-clibut that seems too heavyweight and needs yet another cli to be installed on the machine. Where the pure javascript library is just portable.What this does is that it reverses the highlighting done github API and then it runs the mermaid javascript library on top of the pre tags that are created.
The only downside that I can see is that there is now a dependency on the mermaid javascript library in the template. There might be ways to get around this by loading the file dynamically but that seems far too complex for my taste.
This should hopefully fix #355