Add support for mermaid diagrams#122
Merged
Merged
Conversation
paulbrimicombe
marked this pull request as ready for review
July 17, 2026 10:34
andysteadbbc
approved these changes
Jul 17, 2026
This file contains hidden or 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
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.
🧐 What?
🛠 How
When a Mermaid code block is found:
mermaidclass so the Mermaid JS can detect the diagrams to be rendered/morty-docs/mermaid.min.js(see https://github.com/bbc/morty/pull/353 )CSS rules ensure that:
visibility: hiddenis used to reserve some space (but not the right amount of space) while the diagram renders to avoid at least some of the layout shift when the diagrams render👀 See
Here's an example showing the loading state and the rendered diagrams from https://github.com/bbc/iplayer-catalogue/blob/main/programme/docs/long-form-video/episode-ingest-scenarios.md (existing Morty page: https://broxy.tools.bbc.co.uk/morty-docs/iplayer-catalogue/programme/docs/long-form-video/episode-ingest-scenarios.html )
🐞 Related issue
https://github.com/bbc/morty/issues/308