miro

A native pdf viewer for Windows and Linux (Wayland/X11) with configurable keybindings.

Features

• Dark mode (both for the interface and the pdf)
• Vim-like keybindings (by default)
• Configuration file for key bindings (in case you don't like Vim bindings)
• Mouse controls
• Multiple pdfs in tabs
• Cli arg for opening pdfs from the terminal
• Automatic hot-reloading of any viewed pdf (especially useful when writing anything that compiles into pdfs like Latex/Typst/etc.)

Configuration

An example configuration file is shown at /assets/default.conf which contains all the default bindings for the program. Refer to this file both for configuration syntax and to see the default keybindings.

Installation

Pre-compiled binary

Head over to releases and download the latest binary for your platform, then place it somewhere in your path.

Crates.io

This is pretty much the same as the following option, but doesn't require cloning the repo. See building from source for possible complications when compiling for Windows. I've had no problems compiling on Linux thus far.

cargo install miro

Building from source

On linux, the commands below would clone the repository, compile the project and copy the resulting binary to /usr/bin/.

git clone https://github.com/vincent-uden/miro.git
cd miro
cargo r --release
cp ./target/release/miro /usr/bin/miro

On Windows, the same rough process should work, but often doesn't. I highly recommend downloading a precompiled binary for Windows. The problem lies in compiling the crate mupdf-sys which requires MSVC.

The Visual Studio project embedded in this crate requires Visual Studio 2019 which isn't available for downloading anymore, but can optionally be compiled using Visual Studio 2022. Even with this option, the build might just not work sometimes due to issues with the Windows 10/11 SDK kits which I have not managed to solve.

However, I've managed to get compilation working in github actions which is what produces the release binaries which do function correctly on Windows systems.