|
1 |
| -# Bridged Assistant on Adobe XD |
2 |
| - |
3 |
| - |
| 1 | +# Grida Assistant on Adobe XD |
4 | 2 |
|
5 | 3 | ## references
|
6 |
| -xd plugin react [example](https://github.com/AdobeXD/plugin-samples/tree/master/quick-start-react) |
7 | 4 |
|
| 5 | +xd plugin react [example](https://github.com/AdobeXD/plugin-samples/tree/master/quick-start-react) |
8 | 6 |
|
9 | 7 | [get UXP developer tools](https://www.adobe.io/photoshop/uxp/devtool/)
|
10 | 8 |
|
11 |
| - |
12 | 9 | [XD plugin api docs](https://adobexdplatform.com/plugin-docs/reference/xd-index.html)
|
13 | 10 |
|
14 |
| - |
15 | 11 | # Development
|
16 | 12 |
|
17 | 13 | ## Getting started
|
18 |
| -* One time: Install nodejs (https://nodejs.org/en/download/) and yarn (npm i yarn -g) |
19 |
| -* Open terminal and navigate to the /xd-flutter-plugin-src folder |
20 |
| -* run `yarn` |
21 |
| -* run `yarn build` |
22 |
| -* Plugin files will be copied into the /build folder, and also into your XD plugin developer folder |
23 |
| -* Refresh plugin in XD with `Ctrl+Shift+R` |
| 14 | + |
| 15 | +- One time: Install nodejs (https://nodejs.org/en/download/) and yarn (npm i yarn -g) |
| 16 | +- Open terminal and navigate to the /xd-flutter-plugin-src folder |
| 17 | +- run `yarn` |
| 18 | +- run `yarn build` |
| 19 | +- Plugin files will be copied into the /build folder, and also into your XD plugin developer folder |
| 20 | +- Refresh plugin in XD with `Ctrl+Shift+R` |
24 | 21 |
|
25 | 22 | ## Notes
|
26 |
| -* If you get errors about missing dependencies when building, you probably need to run `yarn` again |
27 |
| -* builds are run in watch mode by default, meaning webpack re-bundles on file save |
| 23 | + |
| 24 | +- If you get errors about missing dependencies when building, you probably need to run `yarn` again |
| 25 | +- builds are run in watch mode by default, meaning webpack re-bundles on file save |
28 | 26 | -> add `--no-watch` to disable watch mode
|
29 |
| -* builds are automatically copied to the XD develop folder, use cmd/ctrl-shft-R in XD to reload plugins |
| 27 | +- builds are automatically copied to the XD develop folder, use cmd/ctrl-shft-R in XD to reload plugins |
30 | 28 |
|
31 | 29 | ## Production builds
|
| 30 | + |
32 | 31 | If you are creating production builds for publishing, there are a few other things to consider:
|
33 |
| -* re-export / test the example thoroughly |
34 |
| -* in version.js: update the `version`, `xdVersionRequired`, & set `debug` to false |
35 |
| -* update the version in manifest.json, and ensure the README and CHANGELOG are up to date (incl. version) and committed. |
36 |
| -* clear the `build` folder and use `yarn build --production` to minifiy and disable sourcemaps |
37 |
| -* create the `xdx` file by zipping the _contents_ of the build folder, and renaming with a `.xdx` extension. |
38 |
| -* once the plugin is submitted, tag the commit with it's version number (ex. `v1.0.0`) |
| 32 | + |
| 33 | +- re-export / test the example thoroughly |
| 34 | +- in version.js: update the `version`, `xdVersionRequired`, & set `debug` to false |
| 35 | +- update the version in manifest.json, and ensure the README and CHANGELOG are up to date (incl. version) and committed. |
| 36 | +- clear the `build` folder and use `yarn build --production` to minifiy and disable sourcemaps |
| 37 | +- create the `xdx` file by zipping the _contents_ of the build folder, and renaming with a `.xdx` extension. |
| 38 | +- once the plugin is submitted, tag the commit with it's version number (ex. `v1.0.0`) |
0 commit comments