Skip to content
mdink edited this page Feb 28, 2026 · 2 revisions

mdink

mdink logo

mdink is a terminal markdown renderer with syntax-highlighted code blocks, inline images (Sixel/Kitty/iTerm2), configurable JSON themes, and vim-style navigation.

mdink README.md

Documentation

Page Description
Installation curl installer, cargo, .deb package, Windows, shell completions, man page
CLI-Reference All flags, environment variables, config file schema, exit codes, examples
Keybindings Keyboard shortcuts for scrolling and navigation
Themes Built-in themes, custom themes, --dump-theme workflow, JSON schema
Terminal-Compatibility Image protocol support matrix by terminal emulator
Font-Slot-Strategy Per-slot font configuration for typographic richness
Architecture Pipeline design, module responsibilities, IR, layout algorithm, invariants
Contributing Prerequisites, dev commands, coding rules, how to add a block type
Release-Process Version bump, tagging, CI pipeline, publishing the draft release

Clone this wiki locally