{"id":13609493,"url":"https://github.com/JakeSteam/Mermaid","last_synced_at":"2025-04-12T20:32:01.337Z","repository":{"id":62909941,"uuid":"463283950","full_name":"JakeSteam/Mermaid","owner":"JakeSteam","description":"A collection of cheatsheets for using Mermaid diagrams on GitHub and elsewhere","archived":false,"fork":false,"pushed_at":"2024-04-01T16:12:39.000Z","size":75,"stargazers_count":316,"open_issues_count":0,"forks_count":39,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-04T18:47:33.151Z","etag":null,"topics":["cheatsheet","mermaid","mermaidjs"],"latest_commit_sha":null,"homepage":"https://blog.jakelee.co.uk/using-mermaid-for-diagrams-on-github/","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/JakeSteam.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-02-24T19:58:53.000Z","updated_at":"2025-03-27T04:33:12.000Z","dependencies_parsed_at":"2024-08-01T19:43:14.972Z","dependency_job_id":"4be472e9-d17e-41c5-9866-ddf5ea126251","html_url":"https://github.com/JakeSteam/Mermaid","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JakeSteam%2FMermaid","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JakeSteam%2FMermaid/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JakeSteam%2FMermaid/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JakeSteam%2FMermaid/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JakeSteam","download_url":"https://codeload.github.com/JakeSteam/Mermaid/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248629763,"owners_count":21136307,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cheatsheet","mermaid","mermaidjs"],"created_at":"2024-08-01T19:01:35.338Z","updated_at":"2025-04-12T20:32:00.811Z","avatar_url":"https://github.com/JakeSteam.png","language":null,"funding_links":[],"categories":["Communication and Collaboration Tools","Others"],"sub_categories":["Version Control, Wiki, Knowledge base"],"readme":"# Mermaid syntax references\n\nA rewrite of [the Mermaid documentation](https://mermaid-js.github.io/mermaid/) as a learning aid and cheatsheet.\n\n\u003ctable\u003e\n\u003ctr\u003e\u003ctd\u003eExample\u003c/td\u003e\u003ctd\u003eCode\u003c/td\u003e\u003c/tr\u003e\n\n\u003ctr\u003e\u003ctd\u003e\n\n```mermaid\nflowchart LR\n    A[Start] --\u003e B{Should you?}\n    B -- Yes --\u003e C{{Do it}}\n    B -- Maybe --\u003e D[(Save for later)]\n    B -- No --\u003e E[Okay]\n```\n\n\u003c/td\u003e\u003ctd\u003e\n\n```\nflowchart LR\n    A[Start] --\u003e B{Should you?}\n    B -- Yes --\u003e C{{Do it}}\n    B -- Maybe --\u003e D[(Save for later)]\n    B -- No --\u003e E[Okay]\n```\n\n\u003ca href=\"/flowchart.md\"\u003eFlowchart in Mermaid cheatsheet\u003c/a\u003e\n\u003c/td\u003e\u003c/tr\u003e\n\u003ctr\u003e\u003ctd\u003e\n\n```mermaid\nsequenceDiagram\n    Alice -\u003e\u003e+ Bob: Here's a message!\n    Bob -\u003e\u003e- Alice: Hmm, ok, thanks.\n```\n\n\u003c/td\u003e\u003ctd\u003e\n\n```\nsequenceDiagram\n    Alice -\u003e\u003e+ Bob: Here's a message!\n    Bob -\u003e\u003e- Alice: Hmm, ok, thanks.\n```\n\n\u003ca href=\"/sequence.md\"\u003eSequence diagram in Mermaid cheatsheet\u003c/a\u003e\n\u003c/td\u003e\u003c/tr\u003e\n\u003ctr\u003e\u003ctd\u003e\n\n```mermaid\nclassDiagram\n    class ClassName {\n        String stringName\n        Long longName\n        MyDatatype attributeName\n\n        functionName(parameter) ReturnType\n        functionName2(parameter2) ReturnType\n    }\n    class Interface {\n        Int intName\n    }\n    ClassName --|\u003e Interface\n```\n\n\u003c/td\u003e\u003ctd\u003e\n\n```\nclassDiagram\n    class ClassName {\n        String stringName\n        Long longName\n        MyDatatype attributeName\n\n        functionName(parameter) ReturnType\n        functionName2(parameter2) ReturnType\n    }\n    class Interface {\n        Int intName\n    }\n    ClassName --|\u003e Interface\n```\n\u003ca href=\"/class.md\"\u003eClass diagram in Mermaid cheatsheet\u003c/a\u003e\u003c/td\u003e\u003c/tr\u003e\n\u003ctr\u003e\u003ctd\u003e\n\n```mermaid\nstateDiagram-v2\n    Stationary --\u003e Moving : Begin moving\n    Moving --\u003e Stationary : Stop moving\n```\n\n\u003c/td\u003e\u003ctd\u003e\n\n```\nstateDiagram-v2\n    Stationary --\u003e Moving : Begin moving\n    Moving --\u003e Stationary : Stop moving\n```\n\n\u003ca href=\"/state.md\"\u003eState diagram in Mermaid cheatsheet\u003c/a\u003e\u003c/td\u003e\u003c/tr\u003e\n\u003ctr\u003e\u003ctd\u003e\n\n```mermaid\nerDiagram\n    User {\n        Int id PK\n        String username\n        Int serverId FK\n    }\n\n    Server {\n        Int id PK\n        String serverName\n    }\n\n    Server ||--o{ User : has\n```\n\n\u003c/td\u003e\u003ctd\u003e\n\n```\nerDiagram\n    User {\n        Int id PK\n        String username\n        Int serverId FK\n    }\n\n    Server {\n        Int id PK\n        String serverName\n    }\n\n    Server ||--o{ User : has\n```\n\u003ca href=\"/entity-relationship.md\"\u003eEntity relationship diagram in Mermaid cheatsheet\u003c/a\u003e\u003c/td\u003e\u003c/tr\u003e\n\u003ctr\u003e\u003ctd\u003e\n\n```mermaid\njourney\n    title User Journey\n    section Logging in\n        Navigate to login: 4: Alice, Bob, Craig\n        Entering details: 2: Alice, Bob\n        Pressing button: 5: Alice\n```\n\n\u003c/td\u003e\u003ctd\u003e\n\n```\njourney\n    title User Journey\n    section Logging in\n        Navigate to login: 4: Alice, Bob, Craig\n        Entering details: 2: Alice, Bob\n        Pressing button: 5: Alice\n```\n\n\u003ca href=\"/user-journey.md\"\u003eUser journey diagram in Mermaid cheatsheet\u003c/a\u003e\u003c/td\u003e\u003c/tr\u003e\n\u003ctr\u003e\u003ctd\u003e\n\n```mermaid\ngantt\n    Dated Milestone: milestone, m1, 2023-01-01, 1d\n    Relative Milestone: milestone, m2, after m1, 1d\n    Task 1: a1, 2023-01-01, 1d\n    Task 2: a2, after a1, 1d\n    Task 3: a3, 2023-01-01, 36hr\n```\n\n\u003c/td\u003e\u003ctd\u003e\n\n```\ngantt\n    Dated Milestone: milestone, m1, 2023-01-01, 1d\n    Relative Milestone: milestone, m2, after m1, 1d\n    Task 1: a1, 2023-01-01, 1d\n    Task 2: a2, after a1, 1d\n    Task 3: a3, 2023-01-01, 36hr\n```\n\n\u003ca href=\"/gantt.md\"\u003eGantt chart in Mermaid cheatsheet\u003c/a\u003e\u003c/td\u003e\u003c/tr\u003e\n\u003ctr\u003e\u003ctd\u003e\n\n```mermaid\npie\n    title Fruits\n    \"Apples\" : 50\n    \"Oranges\" : 20\n    \"Grapes\" : 9.99\n    \"Passionfruits\" : 12.5\n```\n\n\u003c/td\u003e\u003ctd\u003e\n\n```\npie\n    title Fruits\n    \"Apples\" : 50\n    \"Oranges\" : 20\n    \"Grapes\" : 9.99\n    \"Passionfruits\" : 12.5\n```\n\n\u003ca href=\"/pie.md\"\u003ePie chart in Mermaid cheatsheet\u003c/a\u003e\u003c/td\u003e\u003c/tr\u003e\n\u003ctr\u003e\u003ctd\u003e\n\n```mermaid\n    requirementDiagram\n\n    requirement UptimeRequirement {\n        id: 1\n        text: Site Uptime \n        risk: Medium\n        verifymethod: Analysis\n    }\n\n    element satisfyingElement {\n        type: MyElement\n        docref: ABC001\n    }\n\n    element containingElement {\n        type: MyElement\n        docref: ABC002\n    }\n\n    satisfyingElement - satisfies -\u003e UptimeRequirement\n    containingElement - contains -\u003e UptimeRequirement\n```\n\n\u003c/td\u003e\u003ctd\u003e\n\n```\n    requirementDiagram\n\n    requirement UptimeRequirement {\n        id: 1\n        text: Site Uptime \n        risk: Medium\n        verifymethod: Analysis\n    }\n\n    element satisfyingElement {\n        type: MyElement\n        docref: ABC001\n    }\n\n    element containingElement {\n        type: MyElement\n        docref: ABC002\n    }\n\n    satisfyingElement - satisfies -\u003e UptimeRequirement\n    containingElement - contains -\u003e UptimeRequirement\n```\n\n\u003ca href=\"/requirement.md\"\u003eRequirement diagram in Mermaid cheatsheet\u003c/a\u003e\u003c/td\u003e\u003c/tr\u003e\n\u003ctr\u003e\u003ctd\u003e\n\n```mermaid\ngitGraph:\n    commit\n    branch branch2\n    checkout branch2\n    commit\n    checkout main\n    commit\n    merge branch2\n```\n\n\u003c/td\u003e\u003ctd\u003e\n\n```\ngitGraph:\n    commit\n    branch branch2\n    checkout branch2\n    commit\n    checkout main\n    commit\n    merge branch2\n```\n\n\u003ca href=\"/git.md\"\u003eGit graphs in Mermaid cheatsheet\u003c/a\u003e\u003c/td\u003e\u003c/tr\u003e\n\u003c/table\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FJakeSteam%2FMermaid","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FJakeSteam%2FMermaid","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FJakeSteam%2FMermaid/lists"}