乐于分享
好东西不私藏

思源笔记插件开发

思源笔记插件开发

一、获取样板工程源码

1、登录github

必须先登录,否则部分按钮无法显示

privatevoidreadResourcePathList(String rootPath, Set<String> pathList) {Filedir=newFile(rootPath);if (Objects.isNull(dir.listFiles())) return;for (File file : Objects.requireNonNull(dir.listFiles())) {if (file.isDirectory()) {                pathList.add(file.getPath());                readResourcePathList(file.getPath(), pathList);            } else {                pathList.add(file.getPath());            }        }    }

2、拉取项目

项目地址:https://github.com/siyuan-note/plugin-sample-vite-svelte

点击Use this template按钮,将项目复制到自己的库中并改名;若未登录github,则Use this template按钮不会显示

填写仓库相关描述,然后点击Create repository

clone到本地进行开发

3、安装项目依赖

npm install

拉取项目后,idea会自动进行提醒执行npm install命令,用于安装项目依赖,会向项目文件夹中创建 node_modules 文件夹并下载所有相关依赖,其中主要包括 svelte 相关依赖,siyuan 插件开发相关依赖,需要注意的是,可能依赖被下载后没有被正确加载,你需要一次甚至多次重启编辑器来确保其成功加载

4、构建工程

npm run build后,生成dist文件夹和package.zip文件,其中package.zip是在项目根目录下,而不是在dist文件夹下

5、设置make-link命令的目标目录

执行npm run make-link命令

执行后,已经将插件部署到思源的插件目录了

二、开发插件

1、图标尺寸

icon.png:160*160

preview.png:1024*768

2、描述文件

README.md:对应英文描述

README_zh_CN.md:对应中文描述

三、开发过程中遇到的问题

1、插件启用后,重新打开插件自动关闭

原因: 插件目录名称和插件名称要一致

解决办法: 删除软连接后,重新执行命令:make-link

2、打包微信中间API服务器并docker部署

# 1. 确保已编译项目cd /Users/shareyang/SynologyDrive/Code/SyncWeChat/WxAPInpm run build# 2. 构建 Docker 镜像docker build -t wxapi-proxy:latest .# 3. 导出镜像docker save wxapi-proxy:latest | gzip > wxapi-proxy.tar.gz# 4. 查看构建结果docker images | grep wxapi-proxy