docs: render mermaid diagrams on the Pages site#1
Merged
Conversation
stephendchu
force-pushed
the
docs/render-mermaid
branch
from
bc27316 to
3bf7373
Compare
The "gated pipeline" flowchart is already in the README as a ```mermaid block, but Jekyll/kramdown emits it as a language-mermaid code block that Mermaid does not pick up, so it rendered as raw text on the GitHub Pages site. Wire Mermaid.js into the custom layout: rewrite those code blocks to <pre class="mermaid"> and run Mermaid on load. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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
1 participant
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.
The gated pipeline flowchart is already in the README as a ```mermaid block, but it rendered as raw text on https://stephendchu.github.io/assay/ — Jekyll/kramdown emits
<pre><code class="language-mermaid">, which Mermaid doesn't auto-detect.This wires Mermaid.js into the custom
_layouts/default.html: rewrite those code blocks into<pre class="mermaid">and run Mermaid on load. No README change needed — the diagram content was already correct (<br/>line breaks).Once merged, GitHub Pages rebuilds and the diagram renders.
🤖 Generated with Claude Code