A terminal markdown viewer and distraction-free editor built on Charm libraries.
Install
Homebrew
brew install inkcheck/tap/ink
Go
go install github.com/inkcheck/ink/cmd/ink@latest
Build from source
git clone https://github.com/inkcheck/ink.git
cd ink
go install ./cmd/inkUsage
ink # browse .md files in current directory ink /some/path # browse .md files in a specific directory ink -w 100 # set max content width (default: 80)
Key Bindings
Book (file browser)
| Key | Action |
|---|---|
| j/k/arrows | Navigate |
| enter/l | Open file or folder |
| h/left | Go to parent folder |
| n | Create new file |
| / | Filter files |
| ctrl+w | Quit |
Chapter (viewer)
| Key | Action |
|---|---|
| j/k/arrows | Scroll |
| b/f | Page up/down |
| u/d | Half page up/down |
| g/G | Top/bottom |
| e | Open editor |
| E | Open in $EDITOR |
| y | Copy to clipboard |
| ? | Toggle help |
| esc | Back to Book |
Editor
| Key | Action |
|---|---|
| ctrl+s | Save file |
| ctrl+f | Half page down |
| ctrl+b | Half page up |
| ctrl+t | Go to top |
| ctrl+g | Go to bottom |
| ctrl+w | Close editor |
| esc | Close editor |
| alt+z | Zen mode |
| alt+m | Toggle mouse |
| alt+? | Toggle help |
macOS: Enable "Use Option as Meta key" in your terminal settings for Alt shortcuts to work.
ctrl+c quits from any view.
Features
- Markdown rendering with styled headings, code blocks, blockquotes, and lists
- Distraction-free editor with live word count
- Flesch-Kincaid readability grade in viewer and editor
- Directory browsing with subdirectory navigation
- Clipboard copy support
- External editor integration via $EDITOR
- Centered content on wide terminals
Built With
- Bubble Tea - TUI framework
- Bubbles - list, viewport, textarea components
- Lip Gloss - terminal styling
- Goldmark - markdown parsing
- Readability - Flesch-Kincaid scoring
- Claude Code - AI-assisted development