ockertbotha / mermaid-diagramming

Playing with mermaid.

Diagrams

This project has been configured to generate and commit SVG versions of Mermaid diagrams.

---
title: Diagrams to SVG - Action Flowchart 
---
flowchart LR
    create[/Create diagram in markdown/]
    commit(Commit changes)
    push(Push changes to GitHub)

    create --> commit
    commit --> push
    push --> action

    subgraph action[GitHub Action]
      direction LR

      subgraph ubuntu-latest
        direction TB
        checkout(Checkout main branch)
        generate[/Generate SVG diagrams/]
        auto-commit(Auto commit diagrams)

        checkout --> generate
        generate --> auto-commit

      end
    end

Loading

Steps to generate an SVG diagram

1. Add Mermaid syntax to a markdown file.
2. Commit and push changes to GitHub.
3. The GitHub action will automatically execute and if all well a SVG version of the diagram will be generated and added to the same directory.

Tips

• Visit Mermaid for loads more information on diagram syntax.
• For a live preview of diagrams as you edit, use Visual Studio Code and add the Markdown Preview Mermaid plugin.