https://github.com/ahrm/sioyek Skip to content Navigation Menu Toggle navigation Sign in * Product + Actions Automate any workflow + Packages Host and manage packages + Security Find and fix vulnerabilities + Codespaces Instant dev environments + Copilot Write better code with AI + Code review Manage code changes + Issues Plan and track work + Discussions Collaborate outside of code Explore + All features + Documentation + GitHub Skills + Blog * Solutions For + Enterprise + Teams + Startups + Education By Solution + CI/CD & Automation + DevOps + DevSecOps Resources + Learning Pathways + White papers, Ebooks, Webinars + Customer Stories + Partners * Open Source + GitHub Sponsors Fund open source developers + The ReadME Project GitHub community articles Repositories + Topics + Trending + Collections * Pricing Search or jump to... Search code, repositories, users, issues, pull requests... Search [ ] Clear Search syntax tips Provide feedback We read every piece of feedback, and take your input very seriously. [ ] [ ] Include my email address so I can be contacted Cancel Submit feedback Saved searches Use saved searches to filter your results more quickly Name [ ] Query [ ] To see all available qualifiers, see our documentation. Cancel Create saved search Sign in Sign up You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert {{ message }} ahrm / sioyek Public * Notifications * Fork 204 * Star 6.4k * Sioyek is a PDF viewer with a focus on textbooks and research papers sioyek.info/ License GPL-3.0 license 6.4k stars 204 forks Branches Tags Activity Star Notifications * Code * Issues 119 * Pull requests 14 * Discussions * Actions * Projects 0 * Security * Insights Additional navigation options * Code * Issues * Pull requests * Discussions * Actions * Projects * Security * Insights ahrm/sioyek This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository. main BranchesTags Go to file Code Folders and files Last Last Name Name commit commit message date Latest commit History 1,049 Commits .github/workflows .github/workflows mupdf @ a5de2ca mupdf @ a5de2ca pdf_viewer pdf_viewer resources resources scripts scripts tutorial tutorial windows_runtime windows_runtime zlib @ 21767c6 zlib @ 21767c6 .gitattributes .gitattributes .gitignore .gitignore .gitmodules .gitmodules LICENSE LICENSE README.md README.md build_and_release.sh build_and_release.sh build_linux.sh build_linux.sh build_mac.sh build_mac.sh build_windows.bat build_windows.bat delete_build.sh delete_build.sh pdf_viewer_build_config.pro pdf_viewer_build_config.pro tutorial.pdf tutorial.pdf View all files Repository files navigation * README * GPL-3.0 license Sioyek Sioyek is a PDF viewer with a focus on textbooks and research papers. 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 @hrdl-github 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 Sioyek feature overview For a more in-depth tutorial, see this video: Sioyek Tutorial Features Quick Open recent_docs.mp4 You can quickly search and open any file you have previously interacted with using sioyek. Table of Contents 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). sudo dnf install qt5-qtbase-devel qt5-qtbase-static qt5-qt3d-devel harfbuzz-devel git clone --recursive https://github.com/ahrm/sioyek cd sioyek ./build_linux.sh Generic distribution 1. 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. 2. Install libharfbuzz: sudo apt install libharfbuzz-dev 3. Clone the repository and build: git clone --recursive https://github.com/ahrm/sioyek cd sioyek ./build_linux.sh Windows 1. Install Visual Studio (tested on 2019, other relatively recent versions should work too) 2. Install Qt 5 and make sure qmake is in PATH. 3. 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 1. Install Xcode. 2. Clone the repository and build: (The code below is in Zsh, which is the default shell on macOS.) ( setopt PIPE_FAIL PRINT_EXIT_VALUE ERR_RETURN SOURCE_TRACE XTRACE git clone --recursive https://github.com/ahrm/sioyek cd sioyek chmod +x build_mac.sh brew install 'qt@5' freeglut mesa harfbuzz export PATH="/opt/homebrew/opt/qt@5/bin:$PATH" #: The above is needed to make =qmake= from =qt= be found. #: Find the path using =brew info 'qt@5'=. MAKE_PARALLEL=8 ./build_mac.sh mv build/sioyek.app /Applications/ sudo codesign --force --sign - --deep /Applications/sioyek.app ) Donation If you enjoy sioyek, please consider donating to support its development. Buy Me A Coffee About Sioyek is a PDF viewer with a focus on textbooks and research papers sioyek.info/ Topics pdf pdf-viewer research-paper Resources Readme License GPL-3.0 license Activity Stars 6.4k stars Watchers 35 watching Forks 204 forks Report repository Releases 16 Release v2.0.0 Latest Dec 16, 2022 + 15 releases Packages 0 No packages published Contributors 31 * @ahrm * @hrdl-github * @eshrh * @raffaem * @Endle * @rroohhh * @viccie30 * @JingMatrix * @mistzzt * @NightMachinery * @temberature * @kunzaatko * @DakaMonogatari * @kant + 17 contributors Languages * C 89.0% * C++ 9.7% * Python 0.7% * Roff 0.5% * TeX 0.1% * Shell 0.0% Footer (c) 2024 GitHub, Inc. Footer navigation * Terms * Privacy * Security * Status * Docs * Contact * Manage cookies * Do not share my personal information You can't perform that action at this time.