Skip to content

CADWRDeltaModeling/dms_mermaid

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Delta Modeling Section - Mermaid Charts

To generate sleek mermaid charts that are clickable and well-formatted, use this repo.

  1. Create a conda environment using the environment.yml in this repo

    conda env create -f environment.yml

  2. Download the mermaid cli SVG generator

    npm config set registry http://registry.npmjs.org/

    npm config set strict-ssl false

    npm install -g @mermaid-js/mermaid-cli

  3. Create your mermaid diagrams and save as .mmd

  4. Export as SVG

    mmdc -i input.mmd -o output.svg

There is an example.md from PetterTech There are also examples of how to just include a mermaid diagram in your readme.md here

You can also use a VS Code extension but it only works if your file is *.mmd and has the code block:

```mermaid

diagram code

```

Around the diagram code.