logseq-plantuml-plugin/README.md

34 lines
897 B
Markdown

[:heart: Sponsor this project on Github](https://github.com/sponsors/hkgnp)
# Overview
This simple plugin allows you to quickly insert mermaid diagrams in your notes.
![](/screenshots/demo.gif)
# Installation
If not available in the marketplace, [download the latest release](https://github.com/hkgnp/logseq-mermaid-plugin/releases) and manually load it into Logseq after unzipping.
# Usage
To start, simply trigger it using `/Draw mermaid diagram`. Then add your mermaid syntax in the code block and click `Render`.
## Changing background colour
Same steps as above, but before clicking `Render`, include the colour inside the renderer, e.g.
```
{{renderer :mermaid_abc123, purple}}
or
{{renderer :mermaid_abc123, #000000}}
```
# Credits
[mermaid.ink](https://github.com/jihchi/mermaid.ink)
[mermaid-js-converter](https://github.com/superj80820/mermaid-js-converter) for the idea.