diff options
-rw-r--r-- | .github/CONTRIBUTING.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 2f1774756..fcb803e25 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md | |||
@@ -17,6 +17,7 @@ Interested in contributing? Awesome! | |||
17 | - [Server side](#server-side) | 17 | - [Server side](#server-side) |
18 | - [Client side](#client-side) | 18 | - [Client side](#client-side) |
19 | - [Client and server side](#client-and-server-side) | 19 | - [Client and server side](#client-and-server-side) |
20 | - [Embed](#embed) | ||
20 | - [RTL layout](#rtl-layout) | 21 | - [RTL layout](#rtl-layout) |
21 | - [Testing](#testing) | 22 | - [Testing](#testing) |
22 | - [Unit/integration tests](#unitintegration-tests) | 23 | - [Unit/integration tests](#unitintegration-tests) |
@@ -169,6 +170,16 @@ and the web server is automatically restarted. | |||
169 | $ npm run dev | 170 | $ npm run dev |
170 | ``` | 171 | ``` |
171 | 172 | ||
173 | ### Embed | ||
174 | |||
175 | The embed is a standalone application built using Webpack. | ||
176 | The generated files (HTML entrypoint and multiple JS and CSS files) are served by the PeerTube server (behind `localhost:9000/videos/embed/:videoUUID` or `localhost:9000/video-playlists/embed/:playlistUUID`). | ||
177 | The following command will compile embed files and run the PeerTube server: | ||
178 | |||
179 | ``` | ||
180 | $ npm run dev:embed | ||
181 | ``` | ||
182 | |||
172 | ### RTL layout | 183 | ### RTL layout |
173 | 184 | ||
174 | To test RTL layout using `ar` locale: | 185 | To test RTL layout using `ar` locale: |