Skip to content

ooooooook/widget-excalidraw

 
 

Repository files navigation

思源笔记excalidraw挂件

基于 excalidraw 实现的思源笔记挂件。

插件效果(预览&编辑):

功能

  1. 以svg的格式保存excalidraw文件,挂件默认只渲染svg
  2. 支持在独立窗口编辑

部署

  1. 打包, 生成 build 目录

    yarn && yarn build
  2. 将build目录部署至思源笔记, SIYUAN_WORKSPACE 为思源笔记的工作目录

    mv build ${SIYUAN_WORKSPACE}/data/widgets/widget-excalidraw

开发

  1. 配置思源笔记后端服务代理,默认是代理至 http://localhost:6806/,此地址可通过 src/setupProxy.js 修改
  2. 启动服务命令:yarn start
  3. 本地调试。
    • 访问 http://localhost:3000/widgets/widget-excalidraw/?id=${blockId} 可调试编辑界面
    • 访问 http://localhost:3000/widgets/widget-excalidraw/?id=${blockId}&view=1 可调试预览界面

Release

项目集成了GitHub Action CI脚本,支持自动发版。自动发版流程:

  1. 更新 public/widget.json 里面的 "version" 信息
  2. 更新 public/README.md 里面的版本更新日志
  3. 保存提交并推送代码至GitHub仓库,触发构建
  4. 构建完毕之后会生成一个最新版本的Release,tag对应 public/widget.json 里面的 "version"
  5. 等待 思源集市 自动构建(频率每小时一次),构建成功后即可在集市中看到最新版的挂件。

About

思源笔记excalidraw挂件

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages