What Is the Kroki Cheat Sheet and How Can It Help You?

Updated

The Kroki cheat sheet is a quick-reference page that collects syntax examples for the diagram types Kroki supports. It helps you look up the right syntax without leaving the site or digging through each diagram tool's own documentation. It is most useful when you already know roughly what you want to draw but need to confirm the exact keywords, structure, or options for a given diagram type.

What Kroki Is, in One Line

Kroki creates diagrams from textual descriptions. You write a text definition, and Kroki renders it as an image. The site's own heading puts it plainly: "Creates diagrams from textual descriptions!"

That means the cheat sheet is not a separate product. It is a supporting reference for the main service.

What the Cheat Sheet Actually Contains

Based on the site structure, the cheat sheet sits alongside the Try, Features, Examples, and Diagram types sections. Its role is to summarize syntax examples across the supported diagram types in one place.

In practice, that gives you:

  • Syntax samples per diagram type — a starting point you can copy and adapt.
  • A single lookup location — instead of opening the docs for Mermaid, PlantUML, Graphviz, and others separately.
  • A bridge from "Diagram types" to "Try" — you see what a type looks like, then test it.

How It Helps Different Users

Situation How the cheat sheet helps
You are new to Kroki You can see what a valid diagram definition looks like before writing your own.
You know the diagram type but not the syntax You can confirm keywords and structure quickly.
You switch between diagram types You can compare syntax side by side rather than re-learning each tool.
You are prototyping You can copy an example into the Try section and modify it.

A Practical Workflow

  1. Open the Diagram types section to find the kind of diagram you need.
  2. Go to the Cheat sheet to see a syntax example for that type.
  3. Copy the example.
  4. Paste it into the Try section and edit it.
  5. Check the rendered result.

The expected outcome at each step is simple: you move from "I know what I want to draw" to "I have a working text definition."

Common Sticking Points

  • The cheat sheet is a reference, not a tutorial. It shows syntax; it does not explain every concept behind a diagram type.
  • Syntax differs between diagram types. An example for one type will not work for another, so match the example to the type you selected.
  • Examples are starting points. You will still need to replace placeholder content with your own.

When to Use It vs. Other Sections

  • Use the Cheat sheet when you need to check or recall syntax.
  • Use Examples when you want to see fuller, more realistic diagrams.
  • Use Try when you want to test a definition immediately.
  • Use Diagram types when you are deciding what kind of diagram fits your content.

If your goal is to get a diagram rendering quickly, the cheat sheet is the fastest route from an idea to a valid text definition.