Home

Awesome

中文

SiYuan widget sample

Get started

Development

widget.json

{
  "name": "widget-sample",
  "author": "Vanessa",
  "url": "https://github.com/siyuan-note/widget-sample",
  "version": "0.0.3",
  "minAppVersion": "2.8.8",
  "displayName": {
    "default": "Widget Sample",
    "zh_CN": "挂件示例"
  },
  "description": {
    "default": "This is a widget sample",
    "zh_CN": "这是一个挂件示例"
  },
  "readme": {
    "default": "README.md",
    "zh_CN": "README_zh_CN.md"
  },
  "funding": {
    "openCollective": "",
    "patreon": "",
    "github": "",
    "custom": [
      "https://ld246.com/sponsor"
    ]
  },
  "keywords": [
    "sample", "示例"
  ]
}

Package

No matter which method is used to compile and package, we finally need to generate a package.zip, which contains at least the following files:

List on the marketplace

If it is the first release, please create a pull request to the Community Bazaar repository and modify the widgets.json file in it. This file is the index of all community widget repositories, the format is:

{
  "repos": [
    "username/reponame"
  ]
}

After the PR is merged, the bazaar will automatically update the index and deploy through GitHub Actions. When releasing a new version of the widget in the future, you only need to follow the above steps to create a new release, and you don't need to PR the community bazaar repo.

Under normal circumstances, the community bazaar repo will automatically update the index and deploy every hour, and you can check the deployment status at https://github.com/siyuan-note/bazaar/actions.