Sioyek

Sioyek is a PDF viewer designed for reading research papers and technical books.

Help Wanted

I want to do a video tutorial on sioyek, but I am not very good at making videos. If you are interested in collaborating on doing an official video tutorial for sioyek, please contact me at a.hr.mostafavi@gmail.com .

Installation
Documentation
Video Demo
Features
Build Instructions
Buy Me a Coffee (or a Book!)

Install

Official packages

There are installers for Windows, macOS and Linux. See Releases page.

Homebew Cask

There is a homebrew cask available here: https://formulae.brew.sh/cask/sioyek. Install by running:

brew install --cask sioyek

Third-party packages for Linux

If you prefer to install sioyek with a package manager, you can look at this list. Please note that they are provided by third party packagers. USE AT YOUR OWN RISK! If you're reporting a bug for a third-party package, please mention which package you're using.

Distro	Link	Maintainer
Flathub	sioyek	@nbenitez
Alpine	sioyek	@jirutka
Arch	AUR sioyek	@goggle
Arch	AUR Sioyek-git	@randomn4me
Arch	AUR sioyek-appimage	@DhruvaSambrani
NixOS	sioyek	@podocarp

Documentation

You can view the official documentation here.

Feature Video Overview

Features

Quick Open

recent_docs.mp4

You can quickly search and open any file you have previously interacted with using sioyek.

toc.mp4

You can search and jump to table of contents entries.

Smart Jump

jump.mp4

You can jump to any referenced figure or bibliography item even if the PDF file doesn't provide links. You can also search the names of bibliography items in google scholar/libgen by middle clicking/shift+middle clicking on their name.

Overview

overview.mp4

You can open a quick overview of figures/references/tables/etc. by right clicking on them (Like Smart Jump, this feature works even if the document doesn't provide links).

Mark

mark.mp4

Sometimes when reading a document you need to go back a few pages (perhaps to view a definition or something) and quickly jump back to where you were. You can achieve this by using marks. Marks are named locations within a PDF file (each mark has a single character name for example 'a' or 'm') which you can quickly jump to using their name. In the aforementioned example, before going back to the definition you mark your location and later jump back to the mark by invoking its name. Lower case marks are local to the document and upper case marks are global (this should be very familiar to you if you have used vim).

Bookmarks

bookmarks.mp4

Bookmarks are similar to marks except they are named by a text string and they are all global.

Highlights

highlights.mp4

Highlight text using different kinds of highlights. You can search among all the highlights.

Portals (this feature is most useful for users with multiple monitors)

portal.mp4

Suppose you are reading a paragraph which references a figure which is not very close to the current location. Jumping back and forth between the current paragraph and the figure can be very annoying. Using portals, you can link the paragraph's location to the figure's location. Sioyek shows the closest portal destination in a separate window (which is usually placed on a second monitor). This window is automatically updated to show the closest portal destination as the user navigates the document.

Configuration

config.mp4

You can customize all key bindings and some UI elements by editing keys_user.config and prefs_user.config. The default configurations are in keys.config and prefs.config.

Build Instructions

Linux

Fedora

Run the following commands to install dependencies, clone the repository and compile sioyek on Fedora (tested on Fedora Workstation 36).

Notice that we change qmake into qmake-qt5 in build_linux.sh since in Fedora qmake points to qmake for Qt 3.x, while we need qmake for Qt 5.x:

sudo dnf install qt5-qtbase-devel qt5-qtbase-static qt5-qt3d-devel harfbuzz-devel
git clone --recursive https://github.com/ahrm/sioyek
cd sioyek
sed -i "s/qmake/qmake-qt5/g" build_linux.sh
./build_linux.sh

Generic distribution

Install Qt 5 and make sure qmake is in PATH.

Run qmake --version to make sure the qmake in path is using Qt 5.x.
Install libharfbuzz:

sudo apt install libharfbuzz-dev

Clone the repository and build:

git clone --recursive https://github.com/ahrm/sioyek
cd sioyek
./build_linux.sh

Non-US keyboard layout

If you adopt a non-US keyboard layout, run the following after compiling sioyek:

./linux_non_us_keyboard.sh

Windows

Install Visual Studio (tested on 2019, other relatively recent versions should work too)
Install Qt 5 and make sure qmake is in PATH.
Clone the repository and build using 64 bit Visual Studio Developer Command Prompt:

git clone --recursive https://github.com/ahrm/sioyek
cd sioyek
build_windows.bat

Mac

Install Xcode and Qt 5.
Clone the repository and build:

git clone --recursive https://github.com/ahrm/sioyek
cd sioyek
chmod +x build_mac.sh
./build_mac.sh

Donation

If you enjoy sioyek, please consider donating to support its development.

colinsongf/sioyek