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

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

  • 思源笔记扩展

    这里是思源笔记主题、挂件、插件和代码片段等扩展的讨论区。

    25 引用 • 162 回帖
1 操作
zuoez02 在 2023-03-28 12:26:09 更新了该帖

相关帖子

欢迎来到这里!

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

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

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

  • PLA
    捐赠者 订阅者

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

    1 回复
  • zuoez02
    订阅者 作者

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

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

    1 回复
  • PLA
    捐赠者 订阅者

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

    1 回复
  • zuoez02
    订阅者 作者

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

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

    1 回复
  • yuyuyuyu 1 评论
    订阅者

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

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

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

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

    1 回复
  • zuoez02
    订阅者 作者

    不用,会自动更新的。

  • zuoez02
    订阅者 作者

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

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

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

    1 回复
  • yuyuyuyu 1 赞同
    订阅者

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

  • zhaoshengmu

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

    1 回复
  • zuoez02
    订阅者 作者

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

    1 回复
  • MingFox
    订阅者

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

    image.png

  • PLA
    捐赠者 订阅者

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

    image.png

    1 回复
  • zuoez02 1 赞同 1 评论
    订阅者 作者

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

    可以了
    PLA
  • alee2021

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

    需要改成 localhost 才行

    image.png

    1 回复
  • zuoez02
    订阅者 作者

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

  • alee2021

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

  • 503725345

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

    image.png

    1 回复
  • lyd420

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

  • ciwoyipang
    捐赠者 支持者 订阅者

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

    1 回复
  • lyd420

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

    1 回复
  • zuoez02
    订阅者 作者

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

    2 回复
  • lyd420

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

  • banjuer
    订阅者

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

  • karl169

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

    1 回复
  • zuoez02
    订阅者 作者

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

  • yuyuyuyu
    订阅者

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

  • yuyuyuyu
    订阅者

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

  • yuyuyuyu
    订阅者

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

    image.png

请输入回帖内容 ...

推荐标签 标签

  • JRebel

    JRebel 是一款 Java 虚拟机插件,它使得 Java 程序员能在不进行重部署的情况下,即时看到代码的改变对一个应用程序带来的影响。

    26 引用 • 78 回帖 • 578 关注
  • Log4j

    Log4j 是 Apache 开源的一款使用广泛的 Java 日志组件。

    20 引用 • 18 回帖 • 14 关注
  • frp

    frp 是一个可用于内网穿透的高性能的反向代理应用,支持 TCP、UDP、 HTTP 和 HTTPS 协议。

    13 引用 • 5 回帖
  • RabbitMQ

    RabbitMQ 是一个开源的 AMQP 实现,服务器端用 Erlang 语言编写,支持多种语言客户端,如:Python、Ruby、.NET、Java、C、PHP、ActionScript 等。用于在分布式系统中存储转发消息,在易用性、扩展性、高可用性等方面表现不俗。

    49 引用 • 60 回帖 • 449 关注
  • 友情链接

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

    23 引用 • 363 回帖
  • App

    App(应用程序,Application 的缩写)一般指手机软件。

    90 引用 • 376 回帖
  • 设计模式

    设计模式(Design pattern)代表了最佳的实践,通常被有经验的面向对象的软件开发人员所采用。设计模式是软件开发人员在软件开发过程中面临的一般问题的解决方案。这些解决方案是众多软件开发人员经过相当长的一段时间的试验和错误总结出来的。

    190 引用 • 120 回帖 • 1 关注
  • Flutter

    Flutter 是谷歌的移动 UI 框架,可以快速在 iOS 和 Android 上构建高质量的原生用户界面。 Flutter 可以与现有的代码一起工作,它正在被越来越多的开发者和组织使用,并且 Flutter 是完全免费、开源的。

    39 引用 • 92 回帖 • 1 关注
  • QQ

    1999 年 2 月腾讯正式推出“腾讯 QQ”,在线用户由 1999 年的 2 人(马化腾和张志东)到现在已经发展到上亿用户了,在线人数超过一亿,是目前使用最广泛的聊天软件之一。

    45 引用 • 554 回帖 • 362 关注
  • HBase

    HBase 是一个分布式的、面向列的开源数据库,该技术来源于 Fay Chang 所撰写的 Google 论文 “Bigtable:一个结构化数据的分布式存储系统”。就像 Bigtable 利用了 Google 文件系统所提供的分布式数据存储一样,HBase 在 Hadoop 之上提供了类似于 Bigtable 的能力。

    17 引用 • 6 回帖 • 24 关注
  • 30Seconds

    📙 前端知识精选集,包含 HTML、CSS、JavaScript、React、Node、安全等方面,每天仅需 30 秒。

    • 精选常见面试题,帮助您准备下一次面试
    • 精选常见交互,帮助您拥有简洁酷炫的站点
    • 精选有用的 React 片段,帮助你获取最佳实践
    • 精选常见代码集,帮助您提高打码效率
    • 整理前端界的最新资讯,邀您一同探索新世界
    488 引用 • 383 回帖 • 1 关注
  • OpenShift

    红帽提供的 PaaS 云,支持多种编程语言,为开发人员提供了更为灵活的框架、存储选择。

    14 引用 • 20 回帖 • 585 关注
  • Hexo

    Hexo 是一款快速、简洁且高效的博客框架,使用 Node.js 编写。

    20 引用 • 140 回帖 • 38 关注
  • FreeMarker

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

    23 引用 • 20 回帖 • 398 关注
  • OpenStack

    OpenStack 是一个云操作系统,通过数据中心可控制大型的计算、存储、网络等资源池。所有的管理通过前端界面管理员就可以完成,同样也可以通过 Web 接口让最终用户部署资源。

    10 引用
  • 快应用

    快应用 是基于手机硬件平台的新型应用形态;标准是由主流手机厂商组成的快应用联盟联合制定;快应用标准的诞生将在研发接口、能力接入、开发者服务等层面建设标准平台;以平台化的生态模式对个人开发者和企业开发者全品类开放。

    15 引用 • 127 回帖 • 2 关注
  • V2EX

    V2EX 是创意工作者们的社区。这里目前汇聚了超过 400,000 名主要来自互联网行业、游戏行业和媒体行业的创意工作者。V2EX 希望能够成为创意工作者们的生活和事业的一部分。

    17 引用 • 236 回帖 • 580 关注
  • LeetCode

    LeetCode(力扣)是一个全球极客挚爱的高质量技术成长平台,想要学习和提升专业能力从这里开始,充足技术干货等你来啃,轻松拿下 Dream Offer!

    209 引用 • 72 回帖
  • SOHO

    为成为自由职业者在家办公而努力吧!

    7 引用 • 55 回帖 • 144 关注
  • 正则表达式

    正则表达式(Regular Expression)使用单个字符串来描述、匹配一系列遵循某个句法规则的字符串。

    29 引用 • 88 回帖
  • SendCloud

    SendCloud 由搜狐武汉研发中心孵化的项目,是致力于为开发者提供高质量的触发邮件服务的云端邮件发送平台,为开发者提供便利的 API 接口来调用服务,让邮件准确迅速到达用户收件箱并获得强大的追踪数据。

    2 引用 • 8 回帖 • 362 关注
  • 微软

    微软是一家美国跨国科技公司,也是世界 PC 软件开发的先导,由比尔·盖茨与保罗·艾伦创办于 1975 年,公司总部设立在华盛顿州的雷德蒙德(Redmond,邻近西雅图)。以研发、制造、授权和提供广泛的电脑软件服务业务为主。

    8 引用 • 44 回帖
  • BND

    BND(Baidu Netdisk Downloader)是一款图形界面的百度网盘不限速下载器,支持 Windows、Linux 和 Mac,详细介绍请看这里

    107 引用 • 1281 回帖 • 4 关注
  • WordPress

    WordPress 是一个使用 PHP 语言开发的博客平台,用户可以在支持 PHP 和 MySQL 数据库的服务器上架设自己的博客。也可以把 WordPress 当作一个内容管理系统(CMS)来使用。WordPress 是一个免费的开源项目,在 GNU 通用公共许可证(GPLv2)下授权发布。

    45 引用 • 113 回帖 • 384 关注
  • TextBundle

    TextBundle 文件格式旨在应用程序之间交换 Markdown 或 Fountain 之类的纯文本文件时,提供更无缝的用户体验。

    1 引用 • 2 回帖 • 15 关注
  • Google

    Google(Google Inc.,NASDAQ:GOOG)是一家美国上市公司(公有股份公司),于 1998 年 9 月 7 日以私有股份公司的形式创立,设计并管理一个互联网搜索引擎。Google 公司的总部称作“Googleplex”,它位于加利福尼亚山景城。Google 目前被公认为是全球规模最大的搜索引擎,它提供了简单易用的免费服务。不作恶(Don't be evil)是谷歌公司的一项非正式的公司口号。

    53 引用 • 192 回帖 • 1 关注
  • 阿里巴巴

    阿里巴巴网络技术有限公司(简称:阿里巴巴集团)是以曾担任英语教师的马云为首的 18 人,于 1999 年在中国杭州创立,他们相信互联网能够创造公平的竞争环境,让小企业通过创新与科技扩展业务,并在参与国内或全球市场竞争时处于更有利的位置。

    43 引用 • 221 回帖 • 347 关注