Skip to content

Improve Mermaid setup - #1274

Merged
nojaf merged 2 commits into
fsprojects:mainfrom
nojaf:better-mermaid
Aug 31, 2026
Merged

Improve Mermaid setup#1274
nojaf merged 2 commits into
fsprojects:mainfrom
nojaf:better-mermaid

Conversation

@nojaf

@nojaf nojaf commented Aug 31, 2026

Copy link
Copy Markdown
Collaborator

List advice guidance to support plain ```mermaid fenced blocks
promoted by a docs/_body.html script, the pattern used by the fantomas
docs. The source now renders on GitHub and the recipe page actually
renders its own diagrams.

nojaf added 2 commits August 31, 2026 14:51
docs/mermaid.md and rewrite it around plain ```mermaid fenced blocks
promoted by a docs/_body.html script, the pattern used by the fantomas
docs. The source now renders on GitHub and the recipe page actually
renders its own diagrams.
@nojaf

nojaf commented Aug 31, 2026

Copy link
Copy Markdown
Collaborator Author

/repo-assist review

@github-actions

github-actions Bot commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

✓ Repo Assist completed successfully, see workflow run.

Generated by 🌈 Repo Assist, see workflow run. Learn more.

@github-actions

Copy link
Copy Markdown
Contributor

🤖 This is an automated response from Repo Assist.

Reviewed this PR as requested. The approach is solid:

  • docs/_body.html correctly targets code[lang="mermaid"] (matching how Transformations.fs emits <code lang=""> for fenced code blocks), replaces the closest table.pre/pre wrapper, and uses textContent (not innerHTML) to un-escape the HTML-encoded arrows before mermaid parses them — this is the key detail that makes the pattern work.
  • Plain ```mermaid fences now render natively on GitHub and via fsdocs, which is a nice portability win over the old raw <div class="mermaid"> approach.
  • CSS addition centers SVG output cleanly; RELEASE_NOTES.md is updated under [Unreleased]; the old docs/sidebyside/sidemermaid.md is removed and its .sln folder entry replaced correctly.
  • CI (build ubuntu/windows, Ionide analyzers) is green.

No issues found. One minor, non-blocking thought for follow-up: the CDN import in _body.html has no integrity/fallback if jsdelivr is unreachable, but that mirrors the previous setup and is out of scope here.

Looks good to merge from an automated review perspective — final call left to human maintainers as always.

Generated by 🌈 Repo Assist, see workflow run. Learn more.
Comment /repo-assist to run again

Add this agentic workflow to your repo

To install this agentic workflow, run

gh aw add githubnext/agentics/workflows/repo-assist.md@ae8d551f07c7ed7619f8c58c7bb4c3ac89395d38

@nojaf
nojaf merged commit dc03e8d into fsprojects:main Aug 31, 2026
11 checks passed
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.

1 participant