mido
Markdown In, Document Out.
A terminal Markdown reader that renders documents the way a good reader app does: real heading hierarchy, a comfortable line measure, syntax-highlighted code, and tables that line up. Built in Rust on ratatui.
Install
cargo install midoThen open a file, or a whole folder:
mido README.md
mido docs/This documentation is itself a mido project. Run mido docs/ inside the repository to read it in the terminal.
See it run
Recorded with VHS from a tape in the repository and regenerated on every deploy, so it always shows the current release.
One pipeline, two outputs
Every block keeps its source range, so the same model drives the screen, the outline, search, link following and print mode.
A reader, not cat with colors
Browse a folder
Open a directory and the Markdown files hang in a tree on the left. It honours .gitignore and starts on the README.
Keep the outline in view
The headings sit in a card at the top right, fold like a tree and follow where you are reading.
Follow links, keep history
Relative links open in place, anchors jump to their heading, web links open in your browser. Back and forward work like a browser too.
Diagrams in text
Mermaid blocks are drawn with box characters. Flowcharts, sequence, class and state diagrams, pie, gantt and more.
Built in the open
mido is MIT licensed, written in Rust on ratatui, and shaped by the people who read Markdown in a terminal all day. Report a bug, suggest a key, pick up an open issue, or teach it a new element. Every stage of the pipeline has tests to lean on.