diff --git a/Assets/WebsiteAssets/images/news/20240127-icon-category-screenshot.png b/Assets/WebsiteAssets/images/news/20240127-icon-category-screenshot.png new file mode 100644 index 000000000..9b49a7bbe Binary files /dev/null and b/Assets/WebsiteAssets/images/news/20240127-icon-category-screenshot.png differ diff --git a/Assets/WebsiteAssets/images/news/20240127-promo-tile.png b/Assets/WebsiteAssets/images/news/20240127-promo-tile.png new file mode 100644 index 000000000..5d07a4482 Binary files /dev/null and b/Assets/WebsiteAssets/images/news/20240127-promo-tile.png differ diff --git a/readme/api/references/plugin_manifest.md b/readme/api/references/plugin_manifest.md index 9328ce8ee..0b928ab22 100644 --- a/readme/api/references/plugin_manifest.md +++ b/readme/api/references/plugin_manifest.md @@ -15,8 +15,8 @@ Name | Type | Required? | Description `repository_url` | string | No | Repository URL where the plugin source code is hosted. `categories` | string[] | No | [Categories](#categories) that describes the functionality of the plugin. `screenshots` | Image[] | No | [Screenshots](#Screenshot) are used for listing on Joplin Plugin website. -`icons` | Icons | No | If [Icons](#Icons) is not supplied, a standard extension icon will be used by default. You should supply at least a main icon, ideally 48x48 px in size. This is the icon that will be used in various plugin pages. You may, however, supply icons of any size and Joplin will attempt to find the best icon to display in different components. Only PNG icons are allowed. -`promo_tile` | Image | No | [Promo tile](#promo-tile) is an optional image that is used to promote your extension on the Joplin Plugins website. +`icons` | Icons | No | If [Icons](#Icons) is not supplied, a standard plugin icon will be used by default. You should supply at least a main icon, ideally 48x48 px in size. This is the icon that will be used in various plugin pages. You may, however, supply icons of any size and Joplin will attempt to find the best icon to display in different components. Only PNG icons are allowed. +`promo_tile` | Image | No | [Promo tile](#promo-tile) is an optional image that is used to promote your plugin on the Joplin Plugins website. ## Categories diff --git a/readme/news/20240127-new-plugin-metadata.md b/readme/news/20240127-new-plugin-metadata.md new file mode 100644 index 000000000..30910e48f --- /dev/null +++ b/readme/news/20240127-new-plugin-metadata.md @@ -0,0 +1,31 @@ +# Support for new plugin metadata + +The plugin manifest now supports new properties to better describe and present your plugins on Joplin Plugins website. Those are the `icons`, `categories`, `screenshots` and `promo_tile` properties. + +## Icon + +This is the icon that will be used in various plugin pages, including in your main plugin page. It will be shown on the main result page too. If not provided, a default icon will be displayed instead. + +## Category + +You can supply one or more category for your plugin - it will be used to filter the plugins on the website. + +## Screenshots + +Again you can provide one or more screenshots to present your plugin on the website. + +![](https://raw.githubusercontent.com/laurent22/joplin/dev/Assets/WebsiteAssets/images/news/20240127-icon-category-screenshot.png) + +*An example of plugin with icon, category and screenshot* + +## Promo tile + +The promo tile is an optional image that is used to display your plugin on the main website page. If no promo tile is supplied, the icon will be used instead. + +![](https://raw.githubusercontent.com/laurent22/joplin/dev/Assets/WebsiteAssets/images/news/20240127-promo-tile.png) + +*An example of promo tile* + +## More information + +For more information on how to set this plugin metadata, please check the [Plugin Manifest documentation](https://joplinapp.org/help/api/references/plugin_manifest)