Skip to content

Commit 22749ac

Browse files
committed
Merge pull request 'Update Readme for 3.5.0 version' from feature/update-redmi-for-3-5-0-version into develop
Reviewed-on: https://git.onlyoffice.com/ONLYOFFICE/docspace-plugin-sdk/pulls/19
2 parents c3171ed + dede7de commit 22749ac

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,15 @@ You can find a list of all the dialog questions [here](https://github.com/ONLYOF
3232

3333
Code samples are available at [https://github.com/ONLYOFFICE/docspace-plugins](https://github.com/ONLYOFFICE/docspace-plugins).
3434

35+
For plugins created with the old template (SDK 1.1.1), replace the build script in *package.json* with the following:
36+
```json
37+
"build": "webpack && npx build-docspace-plugin"
38+
```
39+
40+
:::note
41+
To ensure the new npx command works correctly, you need to update the globally installed *@onlyoffice/docspace-plugin-sdk* package to version 2.0.0 or higher.
42+
:::
43+
3544
## Building a plugin
3645

3746
To build a plugin, you need the *yarn* package manager to be installed. After that, follow the instructions below:
@@ -54,6 +63,8 @@ yarn install
5463
yarn build
5564
```
5665

57-
This command generates the obfuscated code from the entire project and collects it into the *plugin.js* file using the *webpack* npm package. After that the plugin builder from the [createZip.js](https://github.com/ONLYOFFICE/docspace-plugin-sdk/blob/master/template/scripts/createZip.js) file generates the *config.json* file from the *package.json* data and creates an archive that contains the *assets* folder, the *plugin.js* file, and the *config.json* file.
66+
This command generates the obfuscated code from the entire project and collects it into the *plugin.js* file using the *webpack* npm package.
67+
68+
The *dist* folder will be created in the root plugin folder and the plugin archive will be placed in it. This archive is the completed plugin that can be uploaded to the DocSpace portal.
5869

59-
The *dist* folder will be created in the root plugin folder and the plugin archive will be placed in it. This archive is the completed plugin that can be uploaded to the DocSpace portal.
70+
The old *createZip* script is no longer required and can be safely removed.

0 commit comments

Comments
 (0)