进阶 sli.dev 2026-11-21 18:58:32 · 1 阅读

第14章 编写 Slidev 插件

第14章:编写插件

请先阅读 📖《主题与插件》和 📖《编写主题》。

每个 Slidev 项目只能有一个主题,但可以有多个插件。

功能定位

从理论上讲,主题能实现的所有功能,插件都能实现。但插件更像是一个用于扩展 Slidev 功能的库。

建议在插件中实现以下一项或多项功能: * 提供自定义组件 * 提供新布局 * 提供新代码片段 * 提供新的代码运行器 * 配置 UnoCSS、Vite 等工具

但不建议在插件中做以下事情,这些功能更适合放在主题里: * 通配符全局样式 * 覆盖现有布局 * 覆盖配置项 * 其他可能与主题或其他插件不兼容的功能

插件也可以像主题一样,指定所需的 Slidev 版本。

预览

与主题相同,你可以通过类似 `./slides.md` 的文件来预览你的插件:

``` slides.md --- addons: - ./ --- ```

发布

发布插件时,如 `.vue` 或 `.ts` 等非 JS 文件无需编译即可直接发布。Slidev 在使用插件时会自动编译这些文件。

插件应遵循以下约定: * 包名必须以 `slidev-addon-` 开头。例如 `slidev-addon-name` 或 `@scope/slidev-addon-name` * 在 `package.json` 的 `keywords` 字段中添加 `"slidev-addon"` 和 `"slidev"`

插件可以在本地使用,无需发布到 NPM。如果插件仅供个人使用,你可以直接将其作为本地插件使用,或者发布为私有作用域包。但如果希望与他人分享,建议将其发布到 NPM 注册表。

评论 (0)