Skip to content

feat: added mermaid to readme #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Hyaxon merged 1 commit into from
Oct 30, 2026
Merged

feat: added mermaid to readme #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,21 @@ Run the README rendering regression checks with:
npm test
```

Project pages render fenced `mermaid` blocks as diagrams, including those in
GitHub READMEs. For example:

````markdown
```mermaid
flowchart LR
Source[Schedule JSON] --> Ingestion[Java ingestion]
Ingestion --> Data[Canonical data and snapshots]
```
````

The renderer loads only when a project contains a Mermaid block. Wide diagrams
scroll horizontally; invalid diagrams or unavailable JavaScript leave the
original code block readable.

### Maintaining the static site

- Page and card selectors read build-time collections. Fetch new external content
Expand Down
Loading
Loading