# ink

> A terminal markdown reader that actually looks good.

ink is a command-line tool that renders markdown files in the terminal with rich formatting. Built in Rust as a single binary with no runtime dependencies.

## What it does

- Renders markdown with syntax highlighting, tables, blockquotes, lists, task lists, footnotes, and horizontal rules
- Displays inline images using Unicode half-block characters (works in any terminal with true color)
- Renders mermaid diagrams (flowcharts, sequence diagrams, pie charts, Gantt charts) as ASCII art
- Supports GitHub-style admonitions: NOTE, TIP, IMPORTANT, WARNING, CAUTION
- Supports wikilink syntax: [[page]] and [[page|display text]]
- Interactive TUI with multi-tab support, in-document search, and table of contents sidebar
- File browser mode for exploring directories of markdown files
- 8 built-in color themes with auto dark/light detection, plus custom TOML themes
- Presentation mode (split on --- separators)
- Watch mode for live-reloading on file changes
- Document statistics, outline view, and markdown diff
- Vim-style keybindings (j/k/G/Ctrl+f/Ctrl+b)
- Reads from files, URLs, or stdin
- Plain output mode for piping (ANSI-colored, no TUI)

## Install

cargo install ink

## Usage

ink README.md          # read a file
ink .                  # browse markdown files in current directory
ink --plain file.md    # pipe-friendly ANSI output
ink --slides deck.md   # presentation mode
ink --watch draft.md   # auto-reload on changes
ink outline file.md    # show heading structure
ink stats file.md      # word count, reading time
ink diff a.md b.md     # compare two files

## Links

- Source: https://github.com/borghei/ink
- Website: https://borghei.github.io/ink/
- Author: Amin Borghei (https://github.com/borghei)
- License: Free to use, cannot be sold (see LICENSE)
