Sioyek简介

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

Sioyek是一个专门为科研专业文本阅读而生的阅读器。它有类似于vim编辑器的键位操作，同时支持自定义键位和拓展插件。

为什么使用Sioyek

Sioyek在阅读科研文章或是较长的工具手册时，有许多方便的功能。

下图是Sioyek的Usage：

它的功能亮点在于：

• Vim编辑器类似的键位操作
• 具有History Navigation，在长文本阅读中体验良好
• 在阅读器中内置有预览功能，只要右键便能在原有窗口中打开另一个预览窗口
• 有Smart Jump功能，能够智能跳跃想去到的文章位置
• 有辅助阅读的ruler
• 能够高亮注释、添加书签、添加文本注释，并且可以打开相关的list，快速跳转
• Portals功能支持窗口关联
• "shift + :"进入命令行模式
• 支持自定义拓展

总而言之，这是一个专门阅读专业文本的性能强大的PDF阅读器。

结合Zotero

结合Zotero使用，需要在Zotero中将默认PDF阅读器修改成sioyek.exe的位置。这样，在Zotero中打开的pdf文本就会使用Sioyek打开。

但是会出现一个问题，那就是Sioyek上的注释和书签不能保存下来到Zotero中。这需要我们在Sioyek的相关配置文件中修改参数。以本人的win11操作系统为例子：

## Embed the annotations (highlights and bookmarks) into a new PDF file so they are visible to other PDF readers
embed_annotations ex

取消这一个命令的注释，后边添加的ex是保存含有注释的pdf的快捷键，你可以自定义为你自己喜欢的键位。

这样，在pdf文本中添加了新注释后，你可以ex保存一个含有注释的新pdf文件到指定的路径下。

但是，可以预想到，每次保存都这么操作：创建一个新的pdf文件、手动添加文件名、手动选择保存路径。尤其是Zotero的文件存储路径不好寻找、文件名不好识别。一连串负反馈，使得体验感很差。这时我们可以添加一个文件到Sioyek的安装路径之下：

let state = sioyek_api.get_json_state();
let path = state["document_path"];
let parts = path.split(/[\\/]/); // 兼容 Windows 路径
let file_name = parts[parts.length - 1];
let file_name_parts = file_name.split('.');
let today = new Date();
let yyyy = today.getFullYear();
let mm = String(today.getMonth() + 1).padStart(2, '0');
let dd = String(today.getDate()).padStart(2, '0');
let date_str = yyyy + mm + dd;
let new_name = file_name_parts[0] + "_" + date_str + "." + file_name_parts[1];
let dir = parts.slice(0, parts.length - 1).join('/');
let new_path = dir + '/' + new_name;

// 读取目录下所有pdf文件
let fs = sioyek_api.fs;
let files = fs.readdirSync(dir);
let base_name = file_name_parts[0];
let ext = file_name_parts[1];
let regex = new RegExp('^' + base_name + '_\\d{8}\\.' + ext + '$');
let matched = files.filter(f => regex.test(f));

// 如果匹配的文件超过3个，按日期排序，删除最旧的
if (matched.length > 3) {
    matched.sort((a, b) => {
        let da = a.match(/_(\\d{8})\./)[1];
        let db = b.match(/_(\\d{8})\./)[1];
        return da.localeCompare(db);
    });
    let toDelete = matched.slice(0, matched.length - 3);
    for (let f of toDelete) {
        fs.unlinkSync(dir + '/' + f);
    }
}

// 执行批注嵌入
sioyek.embed_annotations(new_path);

然后在以下文件中添加命令：

new_js_command _embed embed.js

最后在配置文件中任意一个空白行添加键位绑定命令：

_embed es

这样，只要我们每次注释完，按下es，都能在当前编辑的PDF路径下创建一个新的、带有注释的PDF（文件名为：原文件名_日期.pdf）。同时，会检索新建文件前是否超过3个，如果超过就删除日期最早的文件。

Sioyek 使用手册1 📖

一款高效的 PDF 阅读器，支持 Vim 风格操作、标记、书签、同步等高级功能。

快捷键说明 ⌨️

本节所有快捷键均为默认设置，可通过编辑 keys_user.config 文件自定义。每个按键都对应一个命令。

添加快捷键示例：

move_down j

按 : 可打开所有可用命令的可搜索列表。

打开文件 📂

• 拖拽文件到窗口可直接打开。
• 最近文件列表中按 delete 可移除文件（不会从磁盘删除）。

基本移动 🧭

缩放 🔍

• 按住 Ctrl 用鼠标滚轮也可缩放。

历史导航 ⏪⏩

Sioyek 保留完整的浏览历史，支持跨文档跳转。

概览与智能跳转 🖱️

• 右键点击 PDF 链接可快速预览目标位置。
• 即使无链接，右键如“图 2.19”等文本也会尝试打开对应内容概览。
• 中键点击可直接跳转。

可视标记 🟩

• 右键点击文本行显示高亮（可视标记）。
• 按 ` 再右键或再按 ` 可返回上次标记。
• 按 j/k 移动可视标记。
• 按 f7 切换可视滚动模式。
• ruler_mode 设为 0 仅高亮下方，1 为矩形。
• 高亮行时，按 l 可对当前行引用创建概览。
• 按 ] 或 Ctrl+] 可创建 portal 或跳转到定义。

搜索 🔎

• 按 / 或 Ctrl+f 打开搜索菜单。
• 搜索后，按 n/N 跳转下/上一个匹配。
• 输入 c/ 仅在当前章节搜索。
• <起始页,终止页>关键词 限定搜索范围，如 <20,30>Figure。
• overview_next_item/overview_prev_item 可对搜索结果打开概览。

标记 🏷️

• 按 m 后跟字母设定标记，如 ma。
• 按 `a 跳转到标记。
• 标记持久保存，小写仅当前文档，大写全局。

书签 🔖

• 按 b 添加书签，输入描述。
• gb 查看当前文档书签，gB 查看所有文档书签。
• db 删除最近书签，或在列表中选中后按 delete。

高亮 ✨

• 选中文本后按 h+字母创建高亮，如 ha。
• add_highlight_with_current_type 用当前类型高亮。
• toggle_select_highlight 切换高亮选择模式。
• gh 查看当前文档高亮，gH 查看所有文档高亮。
• goto_next_highlight/goto_prev_highlight 导航高亮。
• 删除高亮：左键点击高亮后输入 dh，或在高亮列表中选中后按 delete。

Portal（传送门）🌀

• Portal 用于将段落与被引用内容关联，滚动到段落时自动在辅助窗口显示引用内容。
• 按 p 创建 portal 起点，导航到目标后再按 p 完成。
• 按 p 后点击 PDF 链接或中键点击可自动创建 portal。
• 按 f12 打开/关闭辅助窗口。
• dp 删除最近 portal。
• goto_portal 跳转到 portal 目标。
• Shift+p 编辑 portal 目标。
• 可拖动辅助窗口或用 Ctrl+滚轮调整缩放。

命令菜单 📝

• 按 : 打开命令菜单，列出所有命令及其快捷键。
• 部分命令无快捷键，只能通过命令菜单执行。

外部搜索 🌐

• 选中文本后输入 ss/sl 可在 Google Scholar/Library Genesis 搜索。
• 中键或 Shift+中键点击论文/书名自动搜索。
• 搜索引擎通过 prefs_user.config 中的 search_url_* 配置。
• middle_click_search_engine 和 shift_middle_click_search_engine 配置中键搜索引擎。

Synctex 🔄

• 按 f4 切换 synctex 模式，右键点击文本可在 tex 文件中定位。
• prefs.config 中 inverse_search_command 配置反向搜索命令。例如 VS Code：

inverse_search_command "C:\path\to\vscode\Code.exe" "C:\path\to\vscode\resources\app\out\cli.js" --ms-enable-electron-run-as-node -r -g "%1:%2"

• VS Code latex workshop 示例：

"latex-workshop.view.pdf.external.synctex.command": "C:\\path\\to\\sioyek.exe",
"latex-workshop.view.pdf.external.synctex.args": [
  "--inverse-search",
  "\"C:\\path\\to\\vscode\\Code.exe\" \"C:\\path\\to\\vscode\\resources\\app\\out\\cli.js\" --ms-enable-electron-run-as-node -r -g \"%1:%2\"",
  "--reuse-instance",
  "--forward-search-file",
  "%TEX%",
  "--forward-search-line",
  "%LINE%",
  "%PDF%"
]

• VimTeX 示例：

let g:vimtex_view_method = 'sioyek'

数据与同步 ☁️

• Sioyek 使用 local.db 和 shared.db 两个数据库文件。
• local.db 存储本地数据，shared.db 存储可跨设备同步的数据（如标记、书签、portal 等）。
• prefs_user.config 可设置 shared_database_path，如设为 Dropbox 路径可自动同步。
• 可通过 export/import 命令导出/导入数据。

窗口配置 🖥️

• 按 f12 切换全屏。
• 用 copy_window_size_config 命令保存当前窗口配置。

其他 🛠️

• 选中文本后按 Ctrl+c 复制。
• 按 f 并输入数字可用键盘打开 PDF 链接。
• 按 f8 切换暗色模式。
• 按 f5 切换演示模式。
• 用 toggle_horizontal_scroll_lock 命令锁定水平滚动。
• 用 toggle_custom_color 切换自定义配色方案。
• 用 execute 打开命令行，可用 %1 表示当前文件完整路径，%2 表示文件名，%3 表示当前选中文本。
• 用 embed_annotations 命令导出带有书签/高亮的 PDF 文件。
• 用 rotate_clockwise 和 rotate_counterclockwise 命令旋转页面。

💡 GenAI 应用 + MongoDB Atlas：你无需单独数据库即可开始构建 GenAI 驱动的应用。