Skip to content

disambiguationuk/mermaid-markdown-test

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

39 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

mermaid-markdown-test

Compile Mermaid

This is an example repository which shows off the action Compile Mermaid Markdown (Marketplace).

About Mermaid.js

Generation of diagrams and flowcharts from text in a similar manner as markdown. Ever wanted to simplify documentation and avoid heavy tools like Visio when explaining your code? This is why mermaid was born, a simple markdown-like script language for generating charts from text via javascript. (website)

So why use this action?

Mermaid markdown is not natively handled by github markdown parsing (see gitlab). But there is value in graphs to represent non-tabular data! This enables a repo to focus on the markdown content without having to worry about setting up the toolchain to compile mermaid markdown to an image

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published