最后修改时间:2017-09-13 11:24
如果您想将自己的插件发布到 官方的插件库,可以参考下面的步骤进行操作。
Github 仓库可以用来存放插件相关的代码及所有必须的资源,方便其他用户获取。关于 github 仓库的创建,可以参考 github 文档。
Webhook 是在 github 仓库的 Settings -> Webhooks 中添加和管理的。
点击 “Add webhook” 即可进行添加 webhook 参考,其中接受通知的地址是 https://www.highcharts.com/plugin-registry/hook
,发送请求数据类型为 application/x-www-form-urlencodeed
,并且触发器是 push
。
关于 Webhook 更新详情请参考 github 文档。
MANIFEST 文件是用来存储关于插件信息的,该文件需要的属性及相关信息请参考下表。需要注意的是有:
属性 | 是否必须 | 描述 |
---|---|---|
Name | 是 | 插件的名字,必须是 Highcharts 插件列表中唯一的,并注意尽量简单 |
Version | 是 | 插件的版本号,当插件有更新时版本号必须更新 |
Titles | 是 | $1 |
Author | 是 | 插件的作者,可以是链接或文字 |
Licenses | 是 | 插件的发行授权 |
Dependencies | 是 | 插件所依赖的库或插件,也可以是支持 Highcharts 的版本,例如 Highcharts 4.0 + |
Type | 否 | 类型,可以是 plugin 或 theme ,默认是 plugin |
Description | 否 | 插件介绍 |
Keywords | 否 | 插件的关键词,可以用来检索 |
Homepage | 否 | 插件主页链接,默认是 github 仓库地址 |
Docs | 否 | 插件文档地址,默认是 github 仓库首页 |
Bugs | 否 | Bug 反馈地址,默认是 github issue |
Downloads | 否 | 下载地址 |
Demo | 否 | 插件例子链接,如果是 jsfiddle 链接,则会嵌入展示在插件详情页面 |
Maintainers | 否 | 插件的维护者 |
mainfest.json 文件的示例结构如下,您可以复制下面的内容,除了必要的属性外,其他属性如果没有必要填写,可以删除。
{
"name": "",
"version": "",
"title": "",
"author": {
"name": "",
"url": ""
},
"licenses": [
{
"type": "",
"url": ""
}
],
"dependencies": {
"highcharts": ""
},
"type": "",
"description": "",
"keywords": [
"",
""
],
"homepage": "",
"docs": "",
"bugs": "",
"download": "",
"demo": [
"",
""
],
"maintainers": [
{
"name": "",
"email": "",
"url": ""
}
]
}
当上述步骤都操作完毕后,将代码提交到 github 即可。需要注意一下几点:
订阅更新
尊敬的用户您好:
由于域名备案调整,我们将于 2023-01-01 ~ 2023-01-07 日陆续停用 highcharts.com.cn 域名,受影响的网站及域名如下:
网站或服务名称 | 域名 | 替代的网站 |
---|---|---|
主站 | www.highcharts.com.cn | www.hcharts.cn |
静态资源服务/CDN | cdn.highcharts.com.cn code.highcharts.com.cn | code.hcharts.cn |
img.highcharts.com.cn | img.hcharts.cn | |
API 文档 | api.highcharts.com.cn | api.hcharts.cn |
导出服务 | export.highcharts.com.cn | export.hcharts.cn |
以上网站服务及 highcharts.com.cn 域名下的网站将于 2023-01-08 日全部下线,未来一段时间将不可访问,后续我们将上线新的网站。
如果您的应用中有使用到相关服务,请抓紧时间对链接进行调整(特别是静态资源/CDN 服务的链接),以免影响您的网站或应用的正常运行,由此给您带来的不便,敬请谅解。
如需帮助,请及时与我们联系:0571-86208605 / 18106595564(微信)。
简数科技 2022-12-22