README

Sioyek

Sioyek is a PDF viewer with a focus on textbooks and research papers.

 Development Branch FAQ

 Q: There are build errors with Qt 5..

A: If you are building the development branch you need to use Qt 6.7 or 6.8.

 Q: On MacOS I get "sioyek is damaged and cannot be opened. It is recommended to eject the image.".

A: This is related to macOS quarantine. See https://github.com/ahrm/sioyek/discussions/1156discussioncomment-10822738 .


 Contents
 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
Debian | sioyek | @viccie30
NixOS | sioyek | @podocarp
openSUSE | Publishing | @uncomfyhalomacro
openSUSE | Factory | @uncomfyhalomacro
Ubuntu | sioyek | @viccie30


 Documentation
You can view the official documentation here.
 Feature Video Overview



For a more in-depth tutorial, see this video:



 Features

 Quick Open

https://user-images.githubusercontent.com/6392321/125321111-9b29dc00-e351-11eb-873e-94ea30016a05.mp4

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

 Table of Contents

https://user-images.githubusercontent.com/6392321/125321313-cf050180-e351-11eb-9275-c2759c684af5.mp4

You can search and jump to table of contents entries.

 Smart Jump

https://user-images.githubusercontent.com/6392321/125321419-e5ab5880-e351-11eb-9688-95374a22774f.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

https://user-images.githubusercontent.com/6392321/154683015-0bae4f92-78e2-4141-8446-49dd7c2bd7c9.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

https://user-images.githubusercontent.com/6392321/125321811-505c9400-e352-11eb-85e0-ffc3ae5f8cb8.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