提交插件

把你的插件发布到官方市场。

官方市场(https://github.com/Saber-AI-Research/Novelist-marketplace)是一个纯元数据仓库——你的插件 ZIP 不会被提交进来,它托管在你自己仓库的 GitHub Releases 上。

发布流程

  1. 在你自己的 GitHub 仓库里打一个 release,把构建好的 <id>-<version>.zip 作为 release 资产上传;
  2. Novelist-marketplace 下添加 plugins/<id>/manifest.tomlREADME.md
  3. 发 Pull Request。CI 会:
    • 校验 manifest.toml 的 schema;
    • 从你 release 上拉下 ZIP,做完整性和安全检查(不超过 5 MB、无可疑调用等);
    • 审核通过后合并,registry.json 自动重建。

合并后几分钟内,插件市场首页就会出现你的插件。

manifest.toml 模板

id = "my-plugin"
name = "My Plugin"
version = "1.0.0"
description = "A short sentence about what it does."
author = "your-github-handle"
author_url = "https://github.com/your-github-handle"
repo = "https://github.com/your-github-handle/novelist-my-plugin"
category = "productivity"    # 参见 categories.json
permissions = ["ui", "read"]
tags = ["words", "stats"]
min_novelist_version = "0.1.0"

完整字段和校验规则请见 CONTRIBUTING.md

准备工作检查表

  • 插件已打出 ZIP 并在自己的仓库发了 release
  • manifest.toml 完整
  • README.md 介绍功能、截图、权限说明
  • 有 icon(可选,建议 128×128 PNG,透明背景)
  • 你的 repo 是公开的
  • License 清晰(推荐 MIT / Apache 2.0)

准备好后,fork Novelist-marketplace,把你的文件放进去,提 PR。