[思源笔记第三方插件系统] 插件系统安装指引

本贴最后更新于 404 天前,其中的信息可能已经沧海桑田

2023/3/28 更新:以支持挂件版本安装,详见:[思源笔记第三方插件系统] v0.3.21 发布,支持“插件系统挂件版”


  1. 将如下代码插入到代码片段中(源码可以查看插件系统的 load.js)

    /* SiYuanPluginSystem */
    (function () {
        const path = require('path');
        const getCrossPlatformAppDataFolder = () => {
            let configFilePath;
            if (process.platform === "darwin") {
                configFilePath = path.join(
                    process.env.HOME,
                    "/Library/Application Support"
                );
            } else if (process.platform === "win32") {
                // Roaming包含在APPDATA中了
                configFilePath = process.env.APPDATA;
            } else if (process.platform === "linux") {
                configFilePath = process.env.HOME;
            }
            return configFilePath;
        };
        try {
            const data = require('fs').readFileSync(path.join(getCrossPlatformAppDataFolder(), '.siyuan', 'plugin.js'));
            const script = data.toString('utf8');
            console.log('local plugin system found, loading...');
            eval(script);
    
        } catch (e) {
            console.log('local plugin system not found, load online');
            return fetch('https://gitee.com/zuoez02/siyuan-plugin-system/raw/main/main.js', { cache: 'no-cache' }).then((res) => res.text()).then((sc) => {
                window.siyuanPluginScript = sc;
                eval(sc);
            });
        }
    })();
    

    image
    打开设置
    image
    选择外观 -> 代码片段 设置
    image
    如图所示添加 JS 代码,粘贴代码并开启,点击确定保存
    插件系统将自动完成安装及开启。

  2. image
    右上角出现小齿轮,代表安装完成,点击小齿轮,选择插件系统设置,即可查看当前插件系统配置
    image

  3. 打开你的工作空间目录,在 data​目录下创建 plugins 目录(通过思源菜单-> 工作空间-> 你的工作空间名称-> 打开文件位置即可直接打开)

  4. 将你下载的插件放置在 plugins 目录下,使用插件系统快捷菜单的“重载”功能,页面刷新后,在插件系统菜单的插件列表中即可看到你的插件。每个插件为一个目录,其内部必须包括 main.js​和 manifest.json​两个主要文件
    image

    image

  5. 关闭“安全模式”,在插件列表中开启插件,即可完成插件的加载。
    image
    关闭“安全模式”
    image
    开启你的第三方插件

注意 ⚠️:安全模式的作用是为了确保当开启时不加载第三方插件。由于 Electron 应用复杂的 API 设计,很难做到一个安全的插件系统,因此需要用户个人根据意愿开启或关闭安全模式。当插件系统初次安装时,安全模式为开启状态。

  • 思源笔记

    思源笔记是一款隐私优先的个人知识管理系统,支持完全离线使用,同时也支持端到端加密同步。

    融合块、大纲和双向链接,重构你的思维。

    18862 引用 • 70625 回帖 • 3 关注
1 操作
zuoez02 在 2023-03-28 12:26:09 更新了该帖
优质回帖

欢迎来到这里!

我们正在构建一个小众社区,大家在这里相互信任,以平等 • 自由 • 奔放的价值观进行分享交流。最终,希望大家能够找到与自己志同道合的伙伴,共同成长。

注册 关于
请输入回帖内容 ...
  • foolishman83

    辛苦大佬了,希望插件能够繁荣起来

  • 代码粘贴进去后,没有出现小齿轮,是咋回事?

    1 回复
  • 是不是忘记开启代码片段了?另外可以重启一下思源试试。

    另外注意是 JS 代码片段,不是 CSS

    1 回复
  • js 片段没错,也启用了,默认主题。
    重启了没看到那个小齿轮 😭

    1 回复
  • 版本多少?打开一下开发者控制台,截图一下看看有没有 Plugin System 的输出。

    这个片段依赖外网才能下载到本地

    1 回复
  • yuyuyuyu 1 评论

    请问这个插件系统的安装,有办法打包集成到思源的集市里面吗?

    在集市里面下载以后,就可以使用插件系统?

    1 回复
    现在这个第三方的插件系统安装感觉会劝退大部分人 🥹
    yuyuyuyu
  • qifengle1998

    插件系统后面如果有更新的话,也需要重新这样配置一次吗

    1 回复
  • 不用,会自动更新的。

  • 默认加载代码只有主题和代码片段有能力,插件系统的目的就是避免只有部分主题有能力,让用户只能用某个主题。

    挂件也至少需要应用一次,然后调用接口写代码片段。事实上没有区别,不如用户自己操作。

    有机会的话我会改善这个的,前提是思源提供这个能力

    1 回复
  • yuyuyuyu 1 赞同

    或者插件系统完善以后,给 D 大提个 pull,直接默认整合进思源笔记?

  • 我也是添加了 js 片段并且开启了,关闭思源再打开还是没用

    1 回复
  • 提供一下版本信息和系统信息,另外打开开发者工具截图一下控制台输出吧

    1 回复
  • 如果没有 plugins 目录会报错,要手动创建才能加载,这里可以改进一下

    image.png

  • 2.7.7 版本,我不太懂截图截那里,需要魔法网络吗

    image.png

    1 回复
  • zuoez02 1 赞同 1 评论

    再重启一下试试,刚修复了没有 plugins 目录导致出不来的问题

    可以了
    PLA
  • alee2021

    这段代码里面,IP 地址这个地方显示的是作者的局域网 IP,其他人使用肯定会报错

    需要改成 localhost 才行

    image.png

    1 回复
  • 要粘的代码在文章的最上面,不是图片里的……

  • alee2021

    抱歉,是我之前理解错了,我以为除了那段 JS 代码外,图片里面下方的内容也是要写进去的。

  • 503725345

    同样的。片段代码没错,也启用了,默认主题。
    重启了没看到那个小齿轮。😭

    image.png

    1 回复
  • lyd420

    我也是同样的问题,兄弟你的解决了嘛?

  • 只需要第一第二步就行了。。那些报错的看看你们的代码复制对不对,从思源论坛复制过去下面可是会有原地址这些无关东西要删掉的。

    1 回复
  • lyd420

    已经删掉了,看了一下 js 的报错。。require 这个库好像浏览器拿不到(edge MacOS)

    1 回复
  • 这个现在只能在 electron 客户端执行,不支持浏览器使用

    2 回复
  • lyd420

    了解了~啥时候可以在 web 端运行了辛苦通知大家

  • banjuer

    特来登录感谢大佬,随机头图如果能替换掉思源默认的按钮就更好了。快捷键与默认有点冲突

  • karl169

    /api/file/getFile 读取文件, 没读取到通过 fetch 获取 main.js 文件,再通过/api/asset/upload 或/api/file/putFile 将 js 文件写入思源/data 下某些文件夹,以便下次加载是读取。从而绕过 electron 环境呢。

    1 回复
  • 嗯,计划这么做。并且未来插件系统的 main.js 会跟集市版本的插件系统结合,存储也放到工作空间下。

  • 我今天发现挂件了,大佬行动能力真的强 🙏

  • 如果以后 D 大默认整合这个挂件,然后集市里面开一个插件板块,那就跟 obsidian 一样了

  • 2.8.1,下载挂件就可以进入插件市场了

    image.png

    1 回复
  • 思源 2.8.2 fedora linux,从集市安装了,之后啥也没有呀。

    之前手动加入代码片段,也是啥都没有。重启五六遍了。

    截图 20230403095723.png

    1 回复
  • 再手动加入一次代码片段看看。

    1 回复
  • 谢谢!

    我发现自己好像犯了个小白的错误,那是 js,我顺手给塞到 css 那里去了 😂

    以前一直加 css 来着…从没用过 js。

  • heliox 1 评论

    不行啊,版本 2.8.4,windows

    粘贴进去没反应,前面说的问题都试过了,什么建文件夹,复制时候多出的信息删除

    现在直接用文章第一行提到的通过挂件方式安装。
    openAI
  • 请问怎么完整卸载已经安装的这个第三方插件系统呢?毕竟现在官方已经有插件系统了,感觉两个会冲突

    1 回复
  • 在“设置”-“外观”-“代码片段”-“JS”里面找到 plugin-system 的,关掉它就可以了。挂件也可以卸载掉

    1 回复
  • 好的,谢谢大佬

请输入回帖内容 ...

推荐标签 标签

  • OpenResty

    OpenResty 是一个基于 NGINX 与 Lua 的高性能 Web 平台,其内部集成了大量精良的 Lua 库、第三方模块以及大多数的依赖项。用于方便地搭建能够处理超高并发、扩展性极高的动态 Web 应用、Web 服务和动态网关。

    17 引用 • 41 关注
  • 京东

    京东是中国最大的自营式电商企业,2015 年第一季度在中国自营式 B2C 电商市场的占有率为 56.3%。2014 年 5 月,京东在美国纳斯达克证券交易所正式挂牌上市(股票代码:JD),是中国第一个成功赴美上市的大型综合型电商平台,与腾讯、百度等中国互联网巨头共同跻身全球前十大互联网公司排行榜。

    14 引用 • 102 回帖 • 408 关注
  • gRpc
    10 引用 • 8 回帖 • 55 关注
  • Sillot

    Sillot (汐洛)孵化自思源笔记,致力于服务智慧新彖乄,具有彖乄驱动、极致优雅、开发者友好的特点
    Github 地址:https://github.com/Hi-Windom/Sillot

    19 引用 • 6 回帖 • 29 关注
  • 友情链接

    确认过眼神后的灵魂连接,站在链在!

    24 引用 • 373 回帖 • 1 关注
  • Bootstrap

    Bootstrap 是 Twitter 推出的一个用于前端开发的开源工具包。它由 Twitter 的设计师 Mark Otto 和 Jacob Thornton 合作开发,是一个 CSS / HTML 框架。

    18 引用 • 33 回帖 • 685 关注
  • JavaScript

    JavaScript 一种动态类型、弱类型、基于原型的直译式脚本语言,内置支持类型。它的解释器被称为 JavaScript 引擎,为浏览器的一部分,广泛用于客户端的脚本语言,最早是在 HTML 网页上使用,用来给 HTML 网页增加动态功能。

    711 引用 • 1173 回帖 • 161 关注
  • Thymeleaf

    Thymeleaf 是一款用于渲染 XML/XHTML/HTML5 内容的模板引擎。类似 Velocity、 FreeMarker 等,它也可以轻易的与 Spring 等 Web 框架进行集成作为 Web 应用的模板引擎。与其它模板引擎相比,Thymeleaf 最大的特点是能够直接在浏览器中打开并正确显示模板页面,而不需要启动整个 Web 应用。

    11 引用 • 19 回帖 • 319 关注
  • 书籍

    宋真宗赵恒曾经说过:“书中自有黄金屋,书中自有颜如玉。”

    76 引用 • 390 回帖 • 2 关注
  • CodeMirror
    1 引用 • 2 回帖 • 123 关注
  • 游戏

    沉迷游戏伤身,强撸灰飞烟灭。

    169 引用 • 799 回帖
  • Vditor

    Vditor 是一款浏览器端的 Markdown 编辑器,支持所见即所得、即时渲染(类似 Typora)和分屏预览模式。它使用 TypeScript 实现,支持原生 JavaScript、Vue、React 和 Angular。

    315 引用 • 1667 回帖 • 2 关注
  • Openfire

    Openfire 是开源的、基于可拓展通讯和表示协议 (XMPP)、采用 Java 编程语言开发的实时协作服务器。Openfire 的效率很高,单台服务器可支持上万并发用户。

    6 引用 • 7 回帖 • 88 关注
  • C++

    C++ 是在 C 语言的基础上开发的一种通用编程语言,应用广泛。C++ 支持多种编程范式,面向对象编程、泛型编程和过程化编程。

    106 引用 • 152 回帖
  • 服务器

    服务器,也称伺服器,是提供计算服务的设备。由于服务器需要响应服务请求,并进行处理,因此一般来说服务器应具备承担服务并且保障服务的能力。

    124 引用 • 580 回帖
  • Netty

    Netty 是一个基于 NIO 的客户端-服务器编程框架,使用 Netty 可以让你快速、简单地开发出一个可维护、高性能的网络应用,例如实现了某种协议的客户、服务端应用。

    49 引用 • 33 回帖 • 21 关注
  • 新人

    让我们欢迎这对新人。哦,不好意思说错了,让我们欢迎这位新人!
    新手上路,请谨慎驾驶!

    51 引用 • 226 回帖
  • IBM

    IBM(国际商业机器公司)或万国商业机器公司,简称 IBM(International Business Machines Corporation),总公司在纽约州阿蒙克市。1911 年托马斯·沃森创立于美国,是全球最大的信息技术和业务解决方案公司,拥有全球雇员 30 多万人,业务遍及 160 多个国家和地区。

    16 引用 • 53 回帖 • 122 关注
  • sts
    2 引用 • 2 回帖 • 152 关注
  • PWA

    PWA(Progressive Web App)是 Google 在 2015 年提出、2016 年 6 月开始推广的项目。它结合了一系列现代 Web 技术,在网页应用中实现和原生应用相近的用户体验。

    14 引用 • 69 回帖 • 133 关注
  • MongoDB

    MongoDB(来自于英文单词“Humongous”,中文含义为“庞大”)是一个基于分布式文件存储的数据库,由 C++ 语言编写。旨在为应用提供可扩展的高性能数据存储解决方案。MongoDB 是一个介于关系数据库和非关系数据库之间的产品,是非关系数据库当中功能最丰富,最像关系数据库的。它支持的数据结构非常松散,是类似 JSON 的 BSON 格式,因此可以存储比较复杂的数据类型。

    90 引用 • 59 回帖
  • Kubernetes

    Kubernetes 是 Google 开源的一个容器编排引擎,它支持自动化部署、大规模可伸缩、应用容器化管理。

    108 引用 • 54 回帖 • 1 关注
  • PHP

    PHP(Hypertext Preprocessor)是一种开源脚本语言。语法吸收了 C 语言、 Java 和 Perl 的特点,主要适用于 Web 开发领域,据说是世界上最好的编程语言。

    164 引用 • 407 回帖 • 524 关注
  • Logseq

    Logseq 是一个隐私优先、开源的知识库工具。

    Logseq is a joyful, open-source outliner that works on top of local plain-text Markdown and Org-mode files. Use it to write, organize and share your thoughts, keep your to-do list, and build your own digital garden.

    4 引用 • 55 回帖 • 11 关注
  • Mac

    Mac 是苹果公司自 1984 年起以“Macintosh”开始开发的个人消费型计算机,如:iMac、Mac mini、Macbook Air、Macbook Pro、Macbook、Mac Pro 等计算机。

    164 引用 • 594 回帖 • 1 关注
  • BookxNote

    BookxNote 是一款全新的电子书学习工具,助力您的学习与思考,让您的大脑更高效的记忆。

    笔记整理交给我,一心只读圣贤书。

    1 引用 • 1 回帖 • 1 关注
  • 宕机

    宕机,多指一些网站、游戏、网络应用等服务器一种区别于正常运行的状态,也叫“Down 机”、“当机”或“死机”。宕机状态不仅仅是指服务器“挂掉了”、“死机了”状态,也包括服务器假死、停用、关闭等一些原因而导致出现的不能够正常运行的状态。

    13 引用 • 82 回帖 • 36 关注