插件总览

Novelist 插件系统是如何工作的。

Novelist 的插件系统让你可以在不改动核心代码的前提下为编辑器增加新功能。

安装

直接在 Novelist 里打开「设置 → 插件」,或访问 插件市场 浏览所有可用插件。

每一个插件:

  • 会声明自己需要的 权限
  • 来自公开的 GitHub 仓库,源码可审查;
  • 安装后可以随时禁用或卸载。

点击 浏览插件,或点击任意一个插件详情页里的「在 Novelist 中安装」按钮,会通过 novelist://install-plugin/<id> 深链把安装请求交给应用本体。

插件能做什么

一个插件可以:

  • 注册一个命令(出现在命令面板里,可绑定快捷键);
  • 在侧边栏或底部状态栏加入新视图
  • 在保存、打开、导出等生命周期事件上做动作;
  • 注册导出后端(如自定义 PDF 模板);
  • 提供主题
  • 提供语法扩展(例如新的围栏代码块渲染器)。

权限

为了透明可审查,Novelist 用明确的权限字段来描述插件需要什么:

权限说明
ui注册命令、视图、状态栏项
read读取当前文档内容
write修改当前文档内容
fs读写工作区之外的文件(极少数插件需要)
net访问网络
shell调用外部命令

插件必须在 manifest.toml 中显式声明权限,应用会在安装前向用户展示。

接下来

  • 插件 API — 注册命令、读写文档、挂钩事件的接口
  • 提交插件 — 如何把你的插件提交到官方市场