Repository navigation
ada 1.0: the fastest terminal markdown viewer, for one note or a whole vault. Now on crates.io.
Ada's record of shenanigans, as ada shows it. s sorts the table by any column, and "Took" and "Damage" sort by what 2h 15m and €35 are worth, not as text. Narrow the terminal and the table turns into cards, one per row.
What's in it
- Tables that know their units.
ssorts by any column, and350 µs,1m 30sand€420sort as the values they are. A table too wide for the terminal turns into cards. - Mermaid drawn as text. Sequence diagrams, flowcharts, state diagrams, class diagrams and gantt charts, fitted to the width and colored by the theme, in the pager and in
--print. - Wiki links that survive moves. A
[[link]]finds its note by name anywhere in the vault, as Obsidian does. - Search that sees through markup. A regex
foo barfinds**foo** _bar_. - One previewer for fzf. Notes, code, logs, JSON and images at the pane's size, standing in for both
batandkitten icat. - Also: inline images over kitty, sixel or iTerm2, a git gutter, live reload, callouts and footnotes, mouse support, fourteen themes and your own, remappable keys, and a settings popup (
F2).
It's measured against nine other terminal markdown viewers and bat, on wall time, CPU and memory: the charts.
New since rc.1
- Mermaid class diagrams, and
.mmdand.mermaidfiles, or a diagram piped in, open as the drawing. - Static musl binaries for x86_64 and aarch64 Linux: they run on Alpine and any other Linux.
--code-wrap on|off, and fzf previews cut long code lines at the pane's edge instead of wrapping them.- After a jump, where it landed stays tinted until the next key.
- Documents past 65,535 columns or entries, and nesting 10,000 deep, are held in full.
- A link wrapped inside a word without a space is listed, and rows under a sticky table header no longer take the link focus.
- Less work per frame when redrawing.
The full list is in the changelog.
Install
From crates.io, with Rust 1.88 or newer and a C compiler:
cargo install --locked ada-mdOr a prebuilt binary, for Linux (x86_64, aarch64) and macOS (Apple silicon, Intel):
v=1.0.0 t=x86_64-unknown-linux-gnu
curl -L https://github.com/junkdog/ada-md/releases/download/v$v/ada-$v-$t.tar.gz | tar xz
install -m 755 ada-$v-$t/ada ~/.local/bin/The gnu binaries need glibc 2.34 or newer. The musl ones are static and run on any Linux, Alpine included, but print large files in up to 1.4× the time. The macOS binaries aren't signed. If the archive came through a browser, clear the quarantine flag first: xattr -d com.apple.quarantine ada. SHA256SUMS lists the checksums of the archives.
Windows is mostly untested: ada builds and runs there, but doesn't follow Windows' conventions yet (the config is read from $XDG_CONFIG_HOME or $HOME/.config, links open with xdg-open). The README lists what's missing. Proper support is planned for 1.1.
Known issues
- Inside tmux, images draw as half-blocks (KNOWN_ISSUES.md).
Please report anything odd in issues. --record turns a session into a file you can attach.
