Snapshot of ahrm/sioyek: 10.0k★, C. Sioyek is a PDF viewer with a focus on textbooks and research papers
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
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/1156#discussioncomment-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.
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.
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).
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).
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.
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).
sudo dnf install qt5-qtbase-devel qt5-qtbase-static qt5-qt3d-devel harfbuzz-devel
git clone --recursive --branch development https://github.com/ahrm/sioyek
cd sioyek
./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 --branch development https://github.com/ahrm/sioyek
cd sioyek
./build_linux.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 --branch development https://github.com/ahrm/sioyek
cd sioyek
build_windows.bat
Mac
Uninstall previous Qt6 installed by Homebrew
Install Xcode.
Install Qt6.
pip install aqtinstall
cd /path/to/qt
aqt install-qt mac desktop 6.8.2 clang_64 -m all
export Qt6_DIR=/path/to/qt/6.8.2/macos/
export QT_PLUGIN_PATH=/path/to/qt/6.8.2/macos/plugins
export PKG_CONFIG_PATH=/path/to/qt/6.8.2/macos/lib/pkgconfig
export QML2_IMPORT_PATH=/path/to/qt/6.8.2/macos/qml
export PATH="/path/to/qt/6.8.2/macos/bin:$PATH"
The most recent commit recorded on ahrm/sioyek was 16 days ago, based on the GitHub push timestamp. The repository has 400 forks — one of the better signals of community interest.
Is ahrm/sioyek open source?
Yes — ahrm/sioyek ships under the GPL-3.0 license, which makes its source code freely readable (and, depending on license terms, forkable and reusable). Source: github.com/ahrm/sioyek.
What license does ahrm/sioyek use?
ahrm/sioyek is released under the GPL-3.0 license. Always verify the LICENSE file directly on GitHub for the authoritative terms — license strings can be edited out of sync with a project's actual stance.
What topics is ahrm/sioyek associated with?
GitHub's repository topics for ahrm/sioyek: "pdf", "pdf-viewer", "research-paper". TopGit's editorial category is open-source.
Where can I see ahrm/sioyek in action?
The project maintains a homepage at https://sioyek.info/. The README tab on this page also usually contains screenshots and a quickstart.
Where do I read more about ahrm/sioyek?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/ahrm/sioyek is the definitive source.
Read full README in the tab above.
Want a second opinion on sioyek?
Ask an AI that can read this page — one click and you get its take on sioyek.