Skip to content

Commit e6fdecb

Browse files
author
Steve Kwak
committed
manifest modified
1 parent a0b4491 commit e6fdecb

File tree

1 file changed

+1
-10
lines changed

1 file changed

+1
-10
lines changed

reference/structure/manifest.md

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -44,22 +44,13 @@ The top level of the manifest JSON object contains high-level information about
4444
> Here are the definitions of the keywords in the "Required" column:
4545
> - Develop - required field for XD to run the plugin. If excluded, XD won't load the plugin
4646
> - Publish - required field for plugins to be submitted in the I/O Console and published in the Plugin Manager
47-
> - Optional - optional field for all plugins
4847
4948
Key path | Type | Description | Required
5049
---------|------|-------------|---------
5150
`id` | `string` | Unique identifier for your plugin. You can get your unique ID on the [Adobe I/O Console](https://console.adobe.io/plugins).| Develop / Publish
5251
`name` | `string` | Human-readable *name of your plugin* displayed in the Plugin Manager listing. <br> Must be globally unique among all published plugins. Name availability can be checked on your plugin details page on the [I/O Console](https://console.adobe.io/plugins).<br> The name should be 3 - 45 characters. <br> **Note:** Your plugin name is independent of the _project name_ you created when getting your plugin ID from the I/O Console. The I/O Console project name is for your reference only, and is managed directly on the I/O Console. | Develop / Publish
5352
`version`| `string` | Version number of your plugin in `x.y.z` format. <br>Version must be three segments and each version component must be between `0` and `99`. | Develop / Publish
54-
`description` | `string` | Detailed description displayed in the Plugin Manager listing when "See details" is clicked. <br>The detailed description should be 3 - 1000 characters. | Publish
55-
`summary` | `string` | Short summary displayed in the Plugin Manager listing. <br>Short summary should be 3 - 30 characters. | Publish
56-
`releaseNotes` | `string` | Description of changes displayed to the user when "See details" is clicked in the Plugin Manager listing. <br> Release notes help both your users and the CC Integrations Review team know what's new or fixed in your plugin. <br> Release notes should be 3 - 1000 characters. | Optional
57-
`keywords` | `array<string>` | Keywords for your plugin. <br> Each keyword should be at least 2 characters with a max _concatenated keywords_ length of 100 characters, excluding commas. | Optional
58-
`languages` | `array<string>` | Language(s) supported by your plugin. <br>The language must be a two-letter code from [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes). Currently, only the following codes are allowed: `en` (English), `de` (German), `fr` (French), `ja` (Japanese), `ko` (Korean), `zh` (Chinese), `es` (Spanish), `pt` (Brazilian Portuguese). <br>This field will be displayed in the Plugin Manager to users when "See details" is clicked. | Publish
59-
`website` | `string` | Web address for information about your plugin. <br> This field will be displayed in the Plugin Manager to users when "See details" is clicked. <br>The URL should follow the standard URL format and not exceed 1000 characters.| Optional
60-
`author` | `string` | Plugin author's name. <br> This field will be displayed in the Plugin Manager to users. <br> Name should be 3 - 40 characters.| Publish
61-
`helpUrl` | `string` | Web URL for your plugin's support/help page. <br> This field will become visible in the Plugin Manager to users when "See details" is clicked. <br> The support page you link to must include information on how to get support. <br> The URL should follow the standard URL format and not exceed 1000 characters. <br> **Note:** For GitHub repositories, you should link to a `README.md` file or other Markdown file that describes how to file an issue, or link directly to an issue submission form. _Do not link directly to your repo's list of issues._ | Publish
62-
`icons` | `array<object>` | Icons displayed in the Plugin Manager listing. <br> PNG, JPG/JPEG formats are supported and the max file size for each icon is 1MB. <br> All five sizes are required - `[24, 48, 96, 144, 192]`. | Publish
53+
`icons` | `array<object>` | Icons displayed in the Plugin Manager listing. <br> PNG, JPG/JPEG formats are supported and the max file size for each icon is 1MB. <br> Two sizes are required - `[24, 48]`. | Publish
6354
`host.app` | `string` | Indicates that this is a plugin for Adobe XD (currently, the only valid value here is `"XD"`). | Develop / Publish
6455
`host.minVersion` | `string` | Minimum required version of the host app (in `x.y` format) that can run this plugin. <br> **Note:** Must be two segments. Typically, you'll leave the minor segment set to `0`, e.g. `16.0`. | Develop / Publish
6556
`host.maxVersion` | `string` | Maximum version of host app that can run this plugin. Same formatting as `host.minVersion`. | Optional

0 commit comments

Comments
 (0)