https://github.com/ryuheechul/mermaid-oven
fast iteration is good for your mental health
https://github.com/ryuheechul/mermaid-oven
Last synced: 5 months ago
JSON representation
fast iteration is good for your mental health
- Host: GitHub
- URL: https://github.com/ryuheechul/mermaid-oven
- Owner: ryuheechul
- Created: 2022-03-20T00:54:42.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-03-20T01:28:02.000Z (over 4 years ago)
- Last Synced: 2025-07-15T16:37:38.287Z (12 months ago)
- Language: Makefile
- Size: 1000 Bytes
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# mermaid-oven
It's just an example setup that allows an quick iteration of cooking [mermaid diagrams](https://mermaid-js.github.io/mermaid/#/).
## Prerequisite
- [mermaid-cli](https://github.com/mermaid-js/mermaid-cli) and [entr](https://eradman.com/entrproject/) which can be installed via [./shell.nix](./shell.nix)
- optionally [VSCode](https://code.visualstudio.com/) and [svg viewer extension](https://marketplace.visualstudio.com/items?itemName=cssho.vscode-svgviewer)
## Example
`make keep-building` will keep building watching the [example.mmd](./example.mmd) which will produce `example.mmd.svg`
`make preview` will open [VSCode](https://code.visualstudio.com/)
Assuming [this svg viewer extension](https://marketplace.visualstudio.com/items?itemName=cssho.vscode-svgviewer) is installed on VSCode,
`⌘⇧P` > `SVG Viewer: View SVG` should preview SVG and should refresh whenever the svg files gets updated.
Now you can keep editing via `make edit` and every time you save the file, preview should reflect that as well.