kroki library

Wrapper class for accessing the Kroki.io web service for converting various text diagram sources into SVG images.

Classes

DiagramSample

Used to hold diagram source code examples.

Kroki

The Kroki class provides the convertDiagram method which will package up the diagram source contained within the diagramSource parameter and send it to the Kroki webservice endpoint corresponding to the diagramType parameter. It returns a future which will become the SVG for the converted diagram once the future is completed. If the specified diagramType is not supported or if an error occurs at the endpoint then a text error message will be returned.

KrokiDiagramEndpoints

KrokiDiagramEndpoints Contains a list supportedEndpoints and constants for all Kroki diagram endpoints.

KrokiSampleDiagrams

Contains a list of examples diagrams that Kroki.io supports. For testing and illustration purposes.