文档

快速开始

创建 Sliprail 扩展最快的方式是从官方模板开始。

准备工作

  • Node.js 22 或更高版本
  • npm
  • 发布公开扩展时需要 GitHub 账户
  • 用于本地测试的 Sliprail 桌面版,并启用开发者模式

使用官方模板

扩展模板: sliprail-extension-template

  1. 使用模板创建仓库并克隆到本地
  2. 按照模板 README 安装开发依赖
  3. 在 Sliprail 开发者门户注册扩展,并复制扩展 ID
  4. manifest.json 中填写已注册 ID、显示名称、说明、图标和构建入口
  5. 实现至少一条快捷指令并构建项目
  6. 打开 Sliprail 设置 > 扩展,启用开发者模式并选择加载已解压的扩展
  7. 选择包含 manifest.json 的目录

接下来阅读创建你的第一个扩展,查看最小清单和实现示例。开发过程中可参考运行与调试