DesKit 插件开发文档
面向插件作者的 DesKit 开发指南,从第一个插件到提交应用市场。
DesKit 插件开发文档
DesKit 插件是一小段可以被桌面启动器调用的 JavaScript 包。它不需要接触 Electron 主进程,也不需要理解 DesKit 的内部代码;你只需要声明插件能力、导出命令,并把插件打包成 .deskit 文件。
这份文档只面向插件开发者。它关注三件事:
- 如何从模板创建插件并在本机调试。
- 如何设计命令、视图、动作、设置和权限。
- 如何发布 Release,并把插件提交到 DesKit Marketplace。
推荐阅读路线
如果你是第一次写插件,从这里开始:
- 阅读 快速开始,跑通模板、构建和本地安装。
- 阅读 Manifest,理解 DesKit 如何识别插件。
- 阅读 命令与视图,把用户输入变成可交互结果。
- 如果插件需要剪贴板、网络、后台事件,再阅读 权限 和 剪贴板与后台任务。
- 准备发布时,按 提交到 Marketplace 的流程走。
当前适合开发的插件类型
DesKit 当前最适合这些插件:
- 启动器工具:计算器、时间戳转换、编码解码、格式化。
- 剪贴板工具:历史剪贴板、文本处理、图片处理。
- 带设置的小工具:快捷键、开关、少量文本配置。
- 可发布到 GitHub Release 的独立插件。
如果你的插件需要持续同步、复杂账号系统或长期后台任务,请先把功能拆小。DesKit 的插件框架会继续扩展,目前我们优先保证插件可安装、可运行、可审查。