Add docs for using mermaid with AsciiDoc #1182
Merged
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
mattxwang
requested changes
Mar 6, 2023
There was a problem hiding this comment.
Hi @flyx, sorry for the late response - life has been very hectic! Thank you for submitting a PR - really appreciate it :) hopefully, it'll help future users!
I've left a few nits related to tone and links; let me know what you think. Other than that, I think this is good to merge!
Co-authored-by: Matt Wang <matt@matthewwang.me>
mattxwang
approved these changes
Mar 7, 2023
mattxwang
changed the title
No worries, it is for all of us :) I'm not a native English speaker so I can't judge tone all that much and just applied your edits as they seem fine. I suggest squashing them into the original commit; normally I would amend myself but the web UI doesn't support this. |
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.
As discussed in #1174, this adds a documentation section to UI Components > Code > Mermaid that describes the usage of mermaid with AsciiDoc.
Regarding the comment on asciidoctor-diagram in my edits, I cannot stress enough how much pain this is to set up (this was the first thing I tried before switching to JTD's client-side mermaid support). It basically pre-renders mermaid diagrams in a headless chromium browser. This requires manual configuration of Puppeteer, along with additional config for Jekyll to keep the images the extension creates. And when you managed to get the image on your site, it looks horrible. This is why I wrote „not recommended“.