MarkView

A fast, beautiful, and lightweight desktop Markdown viewer built with Next.js, React, and Tauri.

Features

• File and Folder Support: Open individual Markdown files or entire directories.
• Drag and Drop: Easily drag and drop files directly into the application window.
• Multiple Themes: Choose from 7 built-in themes (Light, Dark, Ocean, Forest, Sunset, Purple, Midnight).
• Persistent Settings: Your selected theme is saved and persists across app restarts.
• Theme Palette: Quick theme switching using a command-palette style interface (Alt+T).
• Searchable Sidebar: Quickly find specific files in your loaded directories (Ctrl+K).
• GitHub Flavored Markdown: Full support for tables, strikethrough, task lists, and more.
• Raw HTML Support: Renders embedded HTML safely.
• Command Line Integration: Open files or folders directly from your terminal.

Keyboard Shortcuts

• Ctrl+K / Cmd+K: Focus file search in the sidebar
• Alt+T: Open theme selector palette
• Up/Down Arrows: Navigate through theme palette
• Enter: Select theme
• Esc: Close theme palette

Installation & Development

Prerequisites

• Node.js & Bun
• Rust & Cargo
• Tauri build dependencies for your OS

Setup

1. Clone the repository
2. Install dependencies:

bun install

Running in Development

To run the application in development mode with hot-reloading:

bun run tauri dev

Building for Production

To build the standalone desktop executable:

bun run tauri build

The compiled binary will be located in src-tauri/target/release/markview.

Usage via Command Line

Once built, you can use the binary from your terminal to open files or folders directly:

# Open a specific file
./markview path/to/README.md

# Open multiple files
./markview file1.md file2.md

# Open a directory (loads all Markdown files within)
./markview .

Architecture

• Frontend: Next.js (App Router, Static Export), React, Tailwind CSS
• Markdown Parsing: react-markdown, remark-gfm, rehype-raw
• Desktop Framework: Tauri v2
• Backend: Rust

License

MIT