瀏覽文檔

短代碼

使用短代碼生成 Kroki 圖表。

語法

閉合語法

1{{< kroki _type=[type] >}}
2DIAGRAM
3{{< /kroki >}}

其與代碼塊用法相似。

自閉合語法

1{{< kroki _type=[type] _name=[name] />}}

參數

_name

索引名稱類型必填默認值版本示例
-_namestring----

圖表文件名稱,支持站點資源和頁面資源。

_type

索引名稱類型必填默認值版本示例
-_typestring---

圖表類型,比如:blockdiagbpmnbytefieldseqdiagactdiagnwdiagpacketdiagrackdiagc4plantumld2dbmlditaaerdexcalidrawgraphvizmermaidnomnomlpikchrplantumlstructurizrsvgbobsymbolatortikzvegavegalitewavedromwireviz

_output

索引名稱類型必填默認值版本示例
-_outputstring-inline--

輸出的類型:inlineembed

其他

你可以為圖表設置任意屬性,比如 idclassdata-* 等等。

示例

站點文件 Kroki 示例

1digraph G {Hello->World}
源碼
1{{< kroki _type="graphviz" _name="diagrams/hello.dot" >}}
結果
GHelloHelloWorldWorldHello->World

頁面文件 Kroki 示例

1graph TD
2  A[ Anyone ] -->|Can help | B( Go to github.com/yuzutech/kroki )
3  B --> C{ How to contribute? }
4  C --> D[ Reporting bugs ]
5  C --> E[ Sharing ideas ]
6  C --> F[ Advocating ]
源碼
1{{< kroki _type="mermaid" _name="diagrams/mermaid.dot" >}}
結果

Can help

Anyone

Go to github.com/yuzutech/kroki

How to contribute?

Reporting bugs

Sharing ideas

Advocating