docsify-swimlanes-io
v1.1.1
Published
A docsify plugin that embed swimlanes.io sequence diagrams.
Downloads
162
Maintainers
Readme
docsify-swimlanes-io is a docsify plugin that let you embed swimlanes.io sequence diagrams in docsify.
How to use
Just add the plugin script:
<script src="//unpkg.com/docsify-swimlanes-io@latest/dist/docsify-swimlanes-io.js"></script>
And add the diagram text:
```swimlanes-io
title: Simple example
A -> B: Ping
B --> A: Pong
```
Alternatively use a <swimlanes-io>
element. This is required if you want to render code blocks in the diagram.
<swimlanes-io>
title: Simple example
A -> B: Ping
note:
```
{
// code block
}
```
B --> A: Pong
</swimlanes-io>
See the swimlanes.io syntax overview for more details.