aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorChocobozzz <me@florianbigard.com>2020-08-21 13:50:33 +0200
committerChocobozzz <chocobozzz@cpy.re>2020-08-21 15:39:51 +0200
commit365783532ea7942b96f5e83f4a4dc8f433a07603 (patch)
tree6a0c399f6557d298d51c6639d3cac8aada652a34
parent0cd6ffc09cd76951fea3d861a6bda7f5984cb9d2 (diff)
downloadPeerTube-365783532ea7942b96f5e83f4a4dc8f433a07603.tar.gz
PeerTube-365783532ea7942b96f5e83f4a4dc8f433a07603.tar.zst
PeerTube-365783532ea7942b96f5e83f4a4dc8f433a07603.zip
Add client build instructions to plugins
-rw-r--r--support/doc/plugins/guide.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/support/doc/plugins/guide.md b/support/doc/plugins/guide.md
index 41d70c372..d6d2114da 100644
--- a/support/doc/plugins/guide.md
+++ b/support/doc/plugins/guide.md
@@ -498,6 +498,31 @@ Translation files are just objects, with the english sentence as the key and the
498} 498}
499``` 499```
500 500
501### Build your plugin
502
503If you added client scripts, you'll need to build them using webpack.
504
505Install webpack:
506
507```
508$ npm install
509```
510
511Add/update your files in the `clientFiles` array of `webpack.config.js`:
512
513```
514$ $EDITOR ./webpack.config.js
515```
516
517Build your client files:
518
519```
520$ npm run build
521```
522
523You built files are in the `dist/` directory. Check `package.json` to correctly point to them.
524
525
501### Test your plugin/theme 526### Test your plugin/theme
502 527
503You'll need to have a local PeerTube instance: 528You'll need to have a local PeerTube instance: