Asciidoctor Kroki Extension

Asciidoctor Kroki is an extension for Asciidoctor.js and Asciidoctor to convert diagrams to images using Kroki.

Kroki provides a unified API with support for many diagram libraries. Write your diagram source directly in AsciiDoc, and Kroki renders it as an image.

Supported environments

The extension is available for:

  • Node.js — use it in your build scripts or Asciidoctor.js-based toolchains

  • Browser — use it directly in the browser

  • Ruby — use it with the Asciidoctor Ruby gem

  • Antora — integrate it into your Antora documentation site

Getting started

Supported diagram types

Asciidoctor Kroki supports over 25 diagram libraries, including PlantUML, Mermaid, GraphViz, D2, Vega-Lite, and more.