About Mermaid is a Javascript based diagramming and charting tool that uses Markdown-inspired text definitions and a renderer to create and modify complex diagrams. The main purpose of Mermaid is to help documentation catch up with development. Doc-Rot is a Catch-22 that Mermaid helps to solve. I'm using mermaid in markdown.I can't figure out how to connect subgraphs. Given the program below, I need to be able to connect one and two with an arrow. ```mermaid graph LR; subgraph one main-MainMenu MainMenu((MainMenu))-Game Game-Level Game-Player end subgraph two Screen end one-two ```.
Latest versionReleased:
Exports mermaid diagrams in Markdown documents as images.
Project description
markdown-mermaid-to-images
A CLI tool for publishing markdown articles to dev.to. The tool will also update articles if they already existon dev.to. It matches articles based on title in the frontmatter.
> Info: You will need to have pandoc preinstalled <https://pandoc.org/installing.html>_ for this script to work correctly. Or you can use the Docker image instead.
Usage
Usage: markdown_mermaid_to_images [OPTIONS]
Exports mermaid diagrams in Markdown documents as images.
| -m, --file PATH | |
| Path to markdown file, where the mermaidcode blocks will be converted to images. | |
| -f, --folder PATH | |
| Path to folder where we will convert allmarkdown mermaid code blocks to images. | |
| -i, --ignore PATH | |
| Path to folder to ignore, markdown files inthis folder will not be converted. | |
| -o, --output PATH | |
| Path to folder where to save the newmarkdown files. [required] | |
| -l, --log-level | |
| [DEBUG|INFO|ERROR]Log level for the script. | |
| --help | Show this message and exit. |
Docker Image
You can also use the Docker image that comes with all the dependencies preinstalled. In this exampleyou can find the output in tests/data/output on your host machine.
Example Markdown File
Where an example markdown file may look something like this. The meramid code blocksmust be surrounded by three ` and have the class mermaid.
This will then get converted into a file that looks like
Mermaid Github Markdown
GitLab CI
You can use also use this in your CI/CD with the provided Docker image. Below is an example .gitlab-ci.yml file,you may wish to use or include. The advantage of this is you can publish your aritcles using CI/CD.
Changelog
You can find the changelog here.
Project details
Release historyRelease notifications | RSS feed
0.2.1.post1
0.2.0
0.1.5
0.1.4
0.1.3.post1
0.1.2
0.1.1
0.1.0.post1
0.1.0
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
| Filename, size | File type | Python version | Upload date | Hashes |
|---|---|---|---|---|
| Filename, size markdown-mermaid-to-images-0.2.1.post1.tar.gz (6.8 kB) | File type Source | Python version None | Upload date | Hashes |
Hashes for markdown-mermaid-to-images-0.2.1.post1.tar.gz
Mermaid Markdown 2019
Mermaid Markdown Image
| Algorithm | Hash digest |
|---|---|
| SHA256 | a14923445e357f961144f866c5bb731f970211573d469406baf6340281099e0f |
| MD5 | 39bf4440bdb491039327cdcfca404176 |
| BLAKE2-256 | df300f09abbd082d1ba26f9dacf804dccf5f1852d40cd6d58b186eb85fd9894d |