skim

A terminal-based markdown viewer built with the Charm Go TUI stack.

Now that I've been working with a lot of markdown files to help my coding agents from forgetting the important stuff, I needed an easier way to navigate them without leaving my terminal, so here is skim.

Features

• Dual-panel layout - File tree (25%) and markdown preview (75%)
• Beautiful rendering - Glamour-powered markdown with automatic light/dark terminal adaptation
• File tree navigation - Expand/collapse directories, filter files with fuzzy search
• In-preview search - Search within content with match highlighting and navigation
• Live reload - Automatic re-render when files change on disk
• Keyboard-driven - Vim-style navigation with full mouse support
• Minimal aesthetic - Clean, editorial design with muted colors

Screenshot

Installation

Quick install (macOS/Linux)

curl -sSfL https://raw.githubusercontent.com/Ayushlm10/skim/main/install.sh | sh

Go install

go install github.com/Ayushlm10/skim@latest

Download binary

Download the latest release for your platform from GitHub Releases.

Build from source

git clone https://github.com/Ayushlm10/skim.git
cd skim
go build -o skim

Usage

# View markdown files in current directory
skim

# View markdown files in a specific directory
skim ~/docs

# View a project's documentation
skim ./specs

Press ? to see all keyboard shortcuts.

Tech Stack

• Bubble Tea - TUI framework
• Lip Gloss - Styling
• Glamour - Markdown rendering
• Bubbles - TUI components
• fsnotify - File watching

License

MIT