1.3.0 • Published 6 months ago
docsify-kroki v1.3.0
docsify-kroki
Install
- Insert script into docsify document:
<script src="//unpkg.com/docsify-kroki"></script>
Usage
#Demo
## embedding it directly
```mermaid
graph TD;
A-->B;
A-->C;
B-->D;
C-->D;
```
```plantuml
@startuml
Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response
Alice -> Bob: Another authentication Request
Alice <-- Bob: another authentication Response
@enduml
```
## load from external files
![kroki-excalidraw](./docs/excalidraw.json)
Options
<script>
window.$docsify = {
// default
kroki: {
langs: [
"actdiag",
"blockdiag",
"bpmn",
"bytefield",
"c4plantuml",
"d2",
"dbml",
"ditaa",
"erd",
"excalidraw",
"graphviz",
"mermaid",
"nomnoml",
"nwdiag",
"packetdiag",
"pikchr",
"plantuml",
"rackdiag",
"seqdiag",
"structurizr",
"svgbob",
"symbolator",
"tikz",
"vega",
"vegalite",
"wavedrom",
"wireviz",
],
// default
serverPath: "//kroki.io/",
},
}
</script>
langs
By default, those markdown language render by kroki:
actdiag | blockdiag | bpmn | bytefield | c4plantuml |
d2 | dbml | ditaa | erd | excalidraw |
graphviz | mermaid | nomnoml | nwdiag | packetdiag |
pikchr | plantuml | rackdiag | seqdiag | structurizr |
svgbob | symbolator | tikz | vega | vegalite |
wavedrom | wireviz |
you can add more to langs array.
serverPath
By default, the official Kroki server is used. If you have your own, configure
it using the serverPath
option:
Example
1.2.0
7 months ago
1.1.1
8 months ago
1.2.2
7 months ago
1.3.0
6 months ago
1.2.1
7 months ago
1.1.2
7 months ago
1.1.0
11 months ago
1.0.22
1 year ago
1.0.21
1 year ago
1.0.20
1 year ago
1.0.19
1 year ago
1.0.18
1 year ago
1.0.17
1 year ago
1.0.16
2 years ago
1.0.15
2 years ago
1.0.14
2 years ago
1.0.13
2 years ago
1.0.12
3 years ago
1.0.11
3 years ago
1.0.10
3 years ago
1.0.9
3 years ago
1.0.8
3 years ago
1.0.7
3 years ago
1.0.6
3 years ago
1.0.5
3 years ago
1.0.4
3 years ago
1.0.3
3 years ago
1.0.3-beta
3 years ago
1.0.2
3 years ago
1.0.1
3 years ago