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

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

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 设计,很难做到一个安全的插件系统,因此需要用户个人根据意愿开启或关闭安全模式。当插件系统初次安装时,安全模式为开启状态。

  • 思源笔记

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

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

    19774 引用 • 75660 回帖 • 1 关注
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 回复
  • 好的,谢谢大佬

请输入回帖内容 ...

推荐标签 标签

  • IDEA

    IDEA 全称 IntelliJ IDEA,是一款 Java 语言开发的集成环境,在业界被公认为最好的 Java 开发工具之一。IDEA 是 JetBrains 公司的产品,这家公司总部位于捷克共和国的首都布拉格,开发人员以严谨著称的东欧程序员为主。

    180 引用 • 400 回帖 • 1 关注
  • NetBeans

    NetBeans 是一个始于 1997 年的 Xelfi 计划,本身是捷克布拉格查理大学的数学及物理学院的学生计划。此计划延伸而成立了一家公司进而发展这个商用版本的 NetBeans IDE,直到 1999 年 Sun 买下此公司。Sun 于次年(2000 年)六月将 NetBeans IDE 开源,直到现在 NetBeans 的社群依然持续增长。

    78 引用 • 102 回帖 • 645 关注
  • RESTful

    一种软件架构设计风格而不是标准,提供了一组设计原则和约束条件,主要用于客户端和服务器交互类的软件。基于这个风格设计的软件可以更简洁,更有层次,更易于实现缓存等机制。

    30 引用 • 114 回帖 • 1 关注
  • PostgreSQL

    PostgreSQL 是一款功能强大的企业级数据库系统,在 BSD 开源许可证下发布。

    22 引用 • 22 回帖
  • 外包

    有空闲时间是接外包好呢还是学习好呢?

    26 引用 • 232 回帖
  • 笔记

    好记性不如烂笔头。

    306 引用 • 782 回帖
  • 友情链接

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

    24 引用 • 373 回帖 • 4 关注
  • Swagger

    Swagger 是一款非常流行的 API 开发工具,它遵循 OpenAPI Specification(这是一种通用的、和编程语言无关的 API 描述规范)。Swagger 贯穿整个 API 生命周期,如 API 的设计、编写文档、测试和部署。

    26 引用 • 35 回帖 • 14 关注
  • Netty

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

    49 引用 • 33 回帖 • 27 关注
  • 996
    13 引用 • 200 回帖 • 2 关注
  • 京东

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

    14 引用 • 102 回帖 • 406 关注
  • jQuery

    jQuery 是一套跨浏览器的 JavaScript 库,强化 HTML 与 JavaScript 之间的操作。由 John Resig 在 2006 年 1 月的 BarCamp NYC 上释出第一个版本。全球约有 28% 的网站使用 jQuery,是非常受欢迎的 JavaScript 库。

    63 引用 • 134 回帖 • 733 关注
  • Laravel

    Laravel 是一套简洁、优雅的 PHP Web 开发框架。它采用 MVC 设计,是一款崇尚开发效率的全栈框架。

    19 引用 • 23 回帖 • 699 关注
  • 单点登录

    单点登录(Single Sign On)是目前比较流行的企业业务整合的解决方案之一。SSO 的定义是在多个应用系统中,用户只需要登录一次就可以访问所有相互信任的应用系统。

    9 引用 • 25 回帖
  • TGIF

    Thank God It's Friday! 感谢老天,总算到星期五啦!

    285 引用 • 4482 回帖 • 658 关注
  • Spark

    Spark 是 UC Berkeley AMP lab 所开源的类 Hadoop MapReduce 的通用并行框架。Spark 拥有 Hadoop MapReduce 所具有的优点;但不同于 MapReduce 的是 Job 中间输出结果可以保存在内存中,从而不再需要读写 HDFS,因此 Spark 能更好地适用于数据挖掘与机器学习等需要迭代的 MapReduce 的算法。

    74 引用 • 46 回帖 • 562 关注
  • WebComponents

    Web Components 是 W3C 定义的标准,它给了前端开发者扩展浏览器标签的能力,可以方便地定制可复用组件,更好的进行模块化开发,解放了前端开发者的生产力。

    1 引用 • 15 关注
  • Solidity

    Solidity 是一种智能合约高级语言,运行在 [以太坊] 虚拟机(EVM)之上。它的语法接近于 JavaScript,是一种面向对象的语言。

    3 引用 • 18 回帖 • 350 关注
  • TensorFlow

    TensorFlow 是一个采用数据流图(data flow graphs),用于数值计算的开源软件库。节点(Nodes)在图中表示数学操作,图中的线(edges)则表示在节点间相互联系的多维数据数组,即张量(tensor)。

    20 引用 • 19 回帖 • 4 关注
  • 又拍云

    又拍云是国内领先的 CDN 服务提供商,国家工信部认证通过的“可信云”,乌云众测平台认证的“安全云”,为移动时代的创业者提供新一代的 CDN 加速服务。

    21 引用 • 37 回帖 • 519 关注
  • MyBatis

    MyBatis 本是 Apache 软件基金会 的一个开源项目 iBatis,2010 年这个项目由 Apache 软件基金会迁移到了 google code,并且改名为 MyBatis ,2013 年 11 月再次迁移到了 GitHub。

    170 引用 • 414 回帖 • 406 关注
  • Jenkins

    Jenkins 是一套开源的持续集成工具。它提供了非常丰富的插件,让构建、部署、自动化集成项目变得简单易用。

    51 引用 • 37 回帖 • 5 关注
  • 运维

    互联网运维工作,以服务为中心,以稳定、安全、高效为三个基本点,确保公司的互联网业务能够 7×24 小时为用户提供高质量的服务。

    148 引用 • 257 回帖 • 3 关注
  • FreeMarker

    FreeMarker 是一款好用且功能强大的 Java 模版引擎。

    23 引用 • 20 回帖 • 434 关注
  • 招聘

    哪里都缺人,哪里都不缺人。

    189 引用 • 1056 回帖
  • Ubuntu

    Ubuntu(友帮拓、优般图、乌班图)是一个以桌面应用为主的 Linux 操作系统,其名称来自非洲南部祖鲁语或豪萨语的“ubuntu”一词,意思是“人性”、“我的存在是因为大家的存在”,是非洲传统的一种价值观,类似华人社会的“仁爱”思想。Ubuntu 的目标在于为一般用户提供一个最新的、同时又相当稳定的主要由自由软件构建而成的操作系统。

    123 引用 • 168 回帖
  • 锤子科技

    锤子科技(Smartisan)成立于 2012 年 5 月,是一家制造移动互联网终端设备的公司,公司的使命是用完美主义的工匠精神,打造用户体验一流的数码消费类产品(智能手机为主),改善人们的生活质量。

    4 引用 • 31 回帖 • 4 关注