Skip to content

Commit

Permalink
support cover image(s) for the plugins
Browse files Browse the repository at this point in the history
  • Loading branch information
oeway committed Apr 24, 2019
1 parent 7320055 commit 45e703a
Show file tree
Hide file tree
Showing 15 changed files with 6,247 additions and 552 deletions.
11 changes: 11 additions & 0 deletions docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,7 @@ Defines the general properties of a plugin with several fields.
"type": "web-worker",
"tags": [],
"ui": "image processing",
"cover": "",
"version": "0.1.0",
"api_version": "0.1.2",
"url": "",
Expand Down Expand Up @@ -195,6 +196,16 @@ Points to current file. It is used to download the plugin when a user installs i
#### description
Contains a short description of the plugin.

#### cover
An url to a cover image of the plugin, it will shown up in the image installation dialog, and also on top of the plugin documentation.

Example: `"cover":"https://imjoy.io/static/img/imjoy-card-plain.png"`.

The cover image is recommended to have a aspect ratio of 16:9.
It can be hosted inside the github repo, in that case, a `raw` url to the image should be used.

Multiple images can be used, by set `cover` to an array: `"cover": ["url_to_image1", "url_to_image2", "url_to_image3"]`.

#### tags
List of supported tags.

Expand Down
Loading

0 comments on commit 45e703a

Please sign in to comment.