文档

创建你的第一个扩展

一旦您通过模板设置了项目,下一步就是注册您的扩展并进行基础配置。这个过程根据您希望创建公开扩展还是私有扩展而略有不同。

注册扩展

所有扩展,无论是公开的还是私有的,都必须在 Sliprail 开发者门户上注册以获取一个唯一的扩展 ID。

  1. 访问开发者门户: 前往 https​://account.fengcen.io/developer
  2. 创建新扩展: 点击创建新扩展的按钮。

创建公开扩展

如果您希望任何人都可以安装和使用您的扩展:

  • 填写信息: 在注册表单中,提供您的扩展名称、描述,并将可见性设置为“公开”。
  • 提供 GitHub 仓库链接: 必须填写您的公开 GitHub 仓库链接。
  • 获取扩展 ID: 注册完成后,您将获得一个扩展 ID。这个 ID 是您的扩展的唯一标识符。

创建私有扩展

如果您创建的扩展仅供自己使用:

  • 填写信息: 在注册表单中,将可见性选项选择为“私有”。
  • GitHub 仓库链接: 您无需填写 GitHub 仓库链接。
  • 获取扩展 ID: 注册后您同样会获得一个扩展 ID。

配置 manifest.json

manifest.json 文件是您扩展的“身份证”,它包含了关于扩展的元数据。最重要的字段是 id

  • 设置扩展 ID: 在您的 manifest.json 文件中,找到 id 字段,并将其值设置为您在开发者门户上注册时获得的扩展 ID。
{
  "id": "your-unique-extension-id",
  "main": "main.js",
  ...
}

这一步对于 Sliprail 正确识别和加载您的扩展至关重要。完成此步骤后,您就可以开始编写扩展的核心功能了。