Skip to content

Commit

Permalink
Add example to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
euneuber committed Oct 1, 2022
1 parent e3329f9 commit 8b56a01
Showing 1 changed file with 24 additions and 9 deletions.
33 changes: 24 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,22 @@
# AddMermaid

Add mermaid.js redering for kanboard markdown texts.
Add mermaid.js rendering for kanboard markdown texts.

See [mermaid.js](https://mermaid-js.github.io/mermaid/#/) for available diagram types and their syntax.

## Author

Author
------------
- Eugen Neuber
- License MIT

Requirements
------------
## Requirements

Kanboard >= v1.0.48
Kanboard installed at a web server.
You can find the download at [kanboard.org](https://kanboard.org/)

Installation
------------
## Installation

Install this plugin by cloning this repository into kanboard plugin directory:

```console
Expand All @@ -27,6 +29,19 @@ Note: Plugin folder is case-sensitive.

### :star: If you like it, do not forget to give a star on GitHub!

:bug: Reporting Issues
------------
## Bug Reporting Issues

Please [create an issue](https://github.com/euneuber/AddMermaid/issues) for any bugs you've found.

## Example

Add this snippet to your markdown text:

```html
<div class="mermaid">
sequenceDiagram
Alice->>John: Hello John, how are you?
John-->>Alice: Great!
Alice-)John: See you later!
</div>
```

0 comments on commit 8b56a01

Please sign in to comment.