tiki/.doc/doki/doc/image-requirements.md
2026-03-25 14:28:23 -04:00

1.4 KiB

Image display requirements

terminal

Images are rendered using the Kitty graphics protocol. The terminal emulator must support this protocol for images to be displayed.

Terminals known to support it include:

In unsupported terminals, images are replaced with their alt text.

SVG images

Rendering SVG files requires resvg to be installed and available in PATH.

# macOS
brew install resvg

# Cargo
cargo install resvg

If resvg is not found, SVG images are not displayed.

Mermaid diagrams

Rendering Mermaid fenced code blocks requires mmdc (Mermaid CLI) to be installed and available in PATH.

npm install -g @mermaid-js/mermaid-cli

If mmdc is not found, Mermaid blocks are displayed as plain code blocks.

Graphviz diagrams

Rendering fenced code blocks tagged dot or graphviz requires dot (from the Graphviz suite) to be installed and available in PATH.

# macOS
brew install graphviz

# Debian / Ubuntu
sudo apt install graphviz

# Fedora
sudo dnf install graphviz

If dot is not found, Graphviz blocks are displayed as plain code blocks.