项目简介
本项目是基于思源笔记的插件开发示例,可帮助开发者快速上手思源笔记插件开发,了解创建、配置和发布思源笔记插件的方法,掌握插件基本开发流程与多语言支持实现方式。
项目的主要特性和功能
- 插件配置:通过
plugin.json
文件配置插件基本信息,如插件名称、作者、版本号、支持的最低思源笔记版本等。 - 多语言支持:支持多语言配置,涵盖插件描述、显示名称和自述文件的多语言版本。
- 实时编译:使用
pnpm run dev
进行实时编译,便于开发调试。 - 插件打包:通过
pnpm run build
生成插件打包文件package.zip
,包含插件必要文件。 - 集市发布:支持将插件发布到思源笔记的社区集市,方便用户下载使用。
安装使用步骤
- 复制项目:将项目复制到本地开发环境,建议把项目文件夹放在
{workspace}/data/plugins/
目录下。 - 安装依赖:确保已安装 NodeJS 和 pnpm,在项目目录下执行
pnpm i
安装依赖。 - 实时编译:执行
pnpm run dev
进行实时编译,方便开发调试。 - 启用插件:在思源笔记中打开集市,进入“下载”选项卡,找到并启用插件。
- 打包发布:执行
pnpm run build
生成package.zip
,再按思源笔记的发布流程将插件发布到社区集市。
下载地址
点击下载 【提取码: 4003】【解压密码: www.makuang.net】