Skip to content

Latest commit

 

History

History
222 lines (176 loc) · 8.93 KB

README_zh_CN.md

File metadata and controls

222 lines (176 loc) · 8.93 KB
Raw

使用 vite + svelte 的思源笔记插件示例

English

本例同 siyuan/plugin-sample v0.3.5

  1. 使用 vite 打包
  2. 使用符号链接、而不是把项目放到插件目录下的模式进行开发
  3. 提供一个github action 模板，能自动生成package.zip并上传到新版本中

开始

  1. 通过 Use this template 按钮将该库文件复制到你自己的库中，请注意库名必须和插件名称一致，默认分支必须为 main
  2. 将你的库克隆到本地开发文件夹中
    • 注意: 同 plugin-sample 不同, 本样例并不推荐直接把代码下载到 {workspace}/data/plugins/
  3. 安装 NodeJS 和 pnpm，然后在开发文件夹下执行 pnpm i 安装所需要的依赖
  4. 自动创建符号链接
    • 打开思源笔记, 确保思源内核正在运行
    • 运行 pnpm run make-link, 脚本会自动检测所有思源的工作空间, 请在命令行中手动输入序号以选择工作空间 
      >>> pnpm run make-link
> plugin-sample-vite@0.0.3 make-link H:\SrcCode\开源项目\plugin-sample-vite
> node  --no-warnings ./scripts/make_dev_link.js

"targetDir" is empty, try to get SiYuan directory automatically....
Got 2 SiYuan workspaces
[0] H:\Media\SiYuan
[1] H:\临时文件夹\SiYuanDevSpace
Please select a workspace[0-1]: 0
Got target directory: H:\Media\SiYuan/data/plugins
Done! Created symlink H:\Media\SiYuan/data/plugins/plugin-sample-vite
  5. 手动创建符号链接
    • 打开 ./scripts/make_dev_link.js 文件，更改 targetDir 为思源的插件目录 <siyuan workspace>/data/plugins
    • 运行 pnpm run make-link 命令, 如果看到类似以下的消息，说明创建成功: 
      ❯❯❯ pnpm run make-link
> plugin-sample-vite@0.0.1 make-link H:\SrcCode\plugin-sample-vite
> node ./scripts/make_dev_link.js

Done! Created symlink H:/SiYuanDevSpace/data/plugins/plugin-sample-vite
  6. 设置环境变量创建符号链接
    • 你也可以设置系统的环境变量 SIYUAN_PLUGIN_DIR 为 /data/plugins 的路径
  7. 执行 pnpm run dev 进行实时编译
  8. 在思源中打开集市并在下载选项卡中启用插件

注意由于使用的 make-link 脚本依赖于 fetch，所以如果想要使用 make-link 请保证至少安装 v18 版本的 nodejs

国际化

国际化方面我们主要考虑的是支持多语言，具体需要完成以下工作：

  • 插件自身的元信息，比如插件描述和自述文件
    • plugin.json 中的 description 和 readme 字段，以及对应的 README*.md 文件
  • 插件中使用的文本，比如按钮文字和提示信息
    • public/i18n/*.json 语言配置文件
    • 代码中使用 this.i18.key 获取文本
  • 最后在 plugin.json 中的 i18n 字段中声明该插件支持的语言
  • yaml 支持
    • 本模板特别支持基于 Yaml 语法的 I18n，见 public/i18n/zh_CN.yaml
    • 编译时，会自动把定义的 yaml 文件翻译成 json 文件放到 dist 或 dev 目录下

建议插件至少支持英文和简体中文，这样可以方便更多人使用。

plugin.json

{
  "name": "plugin-sample-vite",
  "author": "frostime",
  "url": "https://github.com/frostime/plugin-sample-vite",
  "version": "0.1.3",
  "minAppVersion": "2.8.8",
  "backends": ["windows", "linux", "darwin"],
  "frontends": ["desktop"],
  "displayName": {
    "en_US": "Plugin sample with vite and svelte",
    "zh_CN": "插件样例 vite + svelte 版"
  },
  "description": {
    "en_US": "SiYuan plugin sample with vite and svelte",
    "zh_CN": "使用 vite 和 svelte 开发的思源插件样例"
  },
  "readme": {
    "en_US": "README_en_US.md",
    "zh_CN": "README.md"
  },
  "funding": {
    "openCollective": "",
    "patreon": "",
    "github": "",
    "custom": [
      "https://ld246.com/sponsor"
    ]
  },
  "keywords": [
    "sample", "示例"
  ]
}
  • name：插件名称，必须和库名一致，且全局唯一（集市中不能有重名插件）
  • author：插件作者名
  • url：插件仓库地址
  • version：插件版本号，建议遵循 semver 规范
  • minAppVersion：插件支持的最低思源笔记版本号
  • backends：插件需要的后端环境，可选值为 windows, linux, darwin, docker, android, ios and all
    • windows：Windows 桌面端
    • linux：Linux 桌面端
    • darwin：macOS 桌面端
    • docker：Docker 端
    • android：Android 端
    • ios：iOS 端
    • all：所有环境
  • frontends：插件需要的前端环境，可选值为 desktop, desktop-window, mobile, browser-desktop, browser-mobile and all
    • desktop：桌面端
    • desktop-window：桌面端页签转换的独立窗口
    • mobile：移动端
    • browser-desktop：桌面端浏览器
    • browser-mobile：移动端浏览器
    • all：所有环境
  • displayName：模板显示名称，主要用于模板集市列表中显示，支持多语言
    • default：默认语言，必须存在
    • zh_CN、en_US 等其他语言：可选，建议至少提供中文和英文
  • description：插件描述，主要用于插件集市列表中显示，支持多语言
    • default：默认语言，必须存在
    • zh_CN、en_US 等其他语言：可选，建议至少提供中文和英文
  • readme：自述文件名，主要用于插件集市详情页中显示，支持多语言
    • default：默认语言，必须存在
    • zh_CN、en_US 等其他语言：可选，建议至少提供中文和英文
  • funding：插件赞助信息
    • openCollective：Open Collective 名称
    • patreon：Patreon 名称
    • github：GitHub 登录名
    • custom：自定义赞助链接列表
  • keywords：搜索关键字列表，用于集市搜索功能

打包

无论使用何种方式编译打包，我们最终需要生成一个 package.zip，它至少包含如下文件：

  • i18n/*
  • icon.png (160*160)
  • index.css
  • index.js
  • plugin.json
  • preview.png (1024*768)
  • README*.md

上架集市

如果是第一次发布版本，还需要创建一个 PR 到 Community Bazaar 社区集市仓库，修改该库的 plugins.json。该文件是所有社区插件库的索引，格式为：

{
  "repos": [
    "username/reponame"
  ]
}

PR 被合并以后集市会通过 GitHub Actions 自动更新索引并部署。后续发布新版本插件时只需要按照上述步骤创建新的发布即可，不需要再 PR 社区集市仓库。

正常情况下，社区集市仓库每隔 1 小时会自动更新索引并部署，可在 https://github.com/siyuan-note/bazaar/actions 查看部署状态。

使用 Github action 自动发布

样例中自带了 github action，可以自动打包发布，请遵循以下操作：

  1. 设置项目 https://github.com/OWNER/REPO/settings/actions 页面向下划到 Workflow Permissions，打开配置

  2. 需要发布版本的时候，push 一个格式为 v* 的 tag，github 就会自动打包发布 release（包括 package.zip）

  3. 默认使用保守策略进行 pre-release 发布，如果觉得没有必要，可以更改 release.yml 中的设置：

    - name: Release
    uses: ncipollo/release-action@v1
    with:
        allowUpdates: true
        artifactErrorsFailBuild: true
        artifacts: 'package.zip'
        token: ${{ secrets.GITHUB_TOKEN }}
        prerelease: true # 把这个改为 false

开发者须知

思源开发者需注意以下规范。

1. 读写文件规范

插件或者外部扩展如果有直接读取或者写入 data 下文件的需求，请通过调用内核 API 来实现，不要自行调用 fs 或者其他 electron、nodejs API，否则可能会导致数据同步时分块丢失，造成云端数据损坏。

相关 API 见 /api/file/*（例如 /api/file/getFile 等）。

2. Daily Note 属性规范

思源在创建日记的时候会自动为文档添加 custom-dailynote-yyyymmdd 属性，以方便将日记文档同普通文档区分。

详情请见 Github Issue #9807。

开发者在开发手动创建 Daily Note 的功能时请注意：

  • 如果调用了 /api/filetree/createDailyNote 创建日记，那么文档会自动添加这个属性，无需开发者特别处理
  • 如果是开发者代码手动创建文档（例如使用 createDocWithMd API 创建日记），请手动为文档添加该属性