utools 思源笔记搜索插件

项目开源仓库地址: Zuoqiu-Yingyi/utools-siyuan 欢迎点赞 ♪(^∇^*)

本文章不会与项目文档同步更新, 可能已经过时, 具体内容请以项目的 README 为准

背景

思源笔记的全文搜索功能很强大且对中文优化比较好, 所以又多了一个思源笔记的全局搜索入口~

预览

设置界面

搜索界面

功能

插件设置

在 utools 输入框中输入 sy-setting / 思源插件设置 后点击第一个搜索结果即可进入插件设置页面

• 设置发生更改后需要手动点击页面最上方的**保存**按钮保存以保存选项

• 插件设置项

  • 连接思源客户端: 思源笔记内核服务相关设置项

    • 思源服务: 思源笔记内核服务地址, 可以是本地服务地址, 也可以是远程服务地址

      • 端口: 思源笔记内核服务的端口, 可以在 设置>关于>在浏览器上使用 中获取

        • 注: 桌面端第一个打开的工作空间会同时监听一个随机端口与固定的 6806 端口

    • API Token: 思源笔记内核服务的 API Token, 可以在思源笔记 设置 > 关于 > API Token 中获取

      • 若服务未启用 访问授权码 (设置>关于>访问授权码 为空), 则无需设置该选项

  • 搜索设置: 插件搜索功能相关设置项

    • 搜索方案: 插件使用的搜索方案

      • 关键字: 默认选项, 多个关键字使用空格分隔
      • 查询语法: 详情请参考 SQLite FTS5 与 请从这里开始/搜索进阶/查询语法
      • 正则表达式: 使用正则表达式匹配块的内容
      • SQL 语句: 使用 SQL 语句查询数据库

    • 分组方案: 搜索结果分组方案

      • 不分组: 按照排序方案列出搜索结果
      • 按文档分组: 默认选项, 同一个文档的搜索结果相邻列出

    • 排序方案: 搜索结果排序方案

      • 块类型: 按照搜索结果的块类型进行排序, 顺序为 文档块 > 标题块 > 段落块 > 代码块 > 数学公式块 > 表格块 > HTML 块 > 列表块 > 列表项块 > 引述块 > 超级块
      • 原文内容顺序: 仅限分组方案为 按文档分组
      • 相关度降序: 默认选项, 匹配的字符越多的搜索结果越靠前
      • 相关度升序: 匹配的字符越少的搜索结果越靠前
      • 创建时间降序: 创建时间越晚的搜索结果越靠前
      • 创建时间升序: 创建时间越早的搜索结果越靠前
      • 修改时间降序: 最后修改时间越晚的搜索结果越靠前
      • 修改时间升序: 最后修改时间越早的搜索结果越靠前

    • 搜索目录: 在指定文档目录下搜索

      • 默认选项 搜索目录为空时会在所有文档目录下搜索

    • 块类型: 搜索时仅搜索指定的块类型

  • 其他设置: 外观等其他设置

    • 语言: 插件界面语言

      • English
      • 简体中文: 默认选项
      • 繁体中文

    • 主题: 插件界面主题

      • 浅色主题
      • 深色主题
      • 跟随系统: 默认选项

全局搜索

在 utools 输入框中输入 sy / sy-search / 思源搜索 后点击第一个搜索结果即可进入插件设置页面

• 搜索输入框为空时显示最近打开的文档

• 搜索输入框不为空时显示搜索结果

  • 由于思源全局搜索目前启用了分页, 所以目前仅支持显示前 32 个搜索结果
  • 搜索结果内容受到插件配置中的搜索设置配置项影响
  • 搜索结果匹配的关键字会使用 ⸢ 与 ⸥ 包围

• 点击搜索结果会通过 siyuan:// 协议跳转到对应的块

安装

在 utools 插件应用市场中搜索 思源笔记插件 即可自动安装, 或者从项目仓库 Releases 中获取 utools-siyuan.upx 文件拖拽到 utools 手动安装

作者有话说

大家如果还有其他需求与建议欢迎在本文评论区或项目仓库 Issues 中反馈呀~