From 29bd933b6e1a7fe0a73280e29ab5fd467b752b1a Mon Sep 17 00:00:00 2001 From: Josep Boix Requesens Date: Thu, 25 Apr 2024 17:08:50 +0200 Subject: [PATCH] docs: link to pillarbox-web-suite - Adds links to pillarbox-web-suite to the API documentation and README. - Add a link to the personal accces token link. --- docs/README.md | 19 +++++++++++++++---- docs/api/index.md | 19 +++++++++++++++---- 2 files changed, 30 insertions(+), 8 deletions(-) diff --git a/docs/README.md b/docs/README.md index 6b1b69a..7466a27 100644 --- a/docs/README.md +++ b/docs/README.md @@ -17,8 +17,9 @@ To get started with Pillarbox, add the `@srgssr` registry in your `.npmrc` file: @srgssr:registry=https://npm.pkg.github.com ``` -To generate an authentication token follow this -guide: [Authenticating with a personal access token](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#authenticating-with-a-personal-access-token) +Generate a personal access token on the [Personal Access Tokens page][token-settings]. For more +information on using tokens with GitHub packages, +visit: [Authenticating with a Personal Access Token][token-guide]. You can now install it through `npm` the following command: @@ -35,7 +36,7 @@ In your HTML file, add the following code to initialize Pillarbox: Import the CSS file in your HTML to apply Pillarbox default theme: ```html - + ``` Finally, import Pillarbox and set up the player: @@ -51,8 +52,14 @@ player.src({ src: 'urn:swi:video:48115940', type: 'srgssr/urn' }); For detailed information on how to use the Pillarbox Web Player, checkout the [API Documentation](https://srgssr.github.io/pillarbox-web/api). + A live demo of the player is available -here: [Pillarbox Web Demo](https://srgssr.github.io/pillarbox-web-demo/) +here: [Pillarbox Web Demo](https://srgssr.github.io/pillarbox-web-demo/). + +To expand the features that Pillarbox offers out of the box, visit the [Pillarbox Web +Suite](https://github.com/SRGSSR/pillarbox-web-suite). You are welcome to contribute and share your +own components there. + You can create your own theme with the [Pillarbox Theme Editor](https://srgssr.github.io/pillarbox-web-theme-editor). @@ -115,3 +122,7 @@ To contribute to the theme editor go to : https://github.com/SRGSSR/pillarbox-we ## License See the [LICENSE](../LICENSE) file for more information. + +[token-settings]: https://github.com/settings/tokens + +[token-guide]: https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#authenticating-with-a-personal-access-token diff --git a/docs/api/index.md b/docs/api/index.md index 4440933..2a82990 100644 --- a/docs/api/index.md +++ b/docs/api/index.md @@ -12,8 +12,9 @@ To get started with Pillarbox, add the `@srgssr` registry in your `.npmrc` file: @srgssr:registry=https://npm.pkg.github.com ``` -To generate an authentication token follow this -guide: [Authenticating with a personal access token](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#authenticating-with-a-personal-access-token) +Generate a personal access token on the [Personal Access Tokens page][token-settings]. For more +information on using tokens with GitHub packages, +visit: [Authenticating with a Personal Access Token][token-guide]. You can now install it through `npm` the following command: @@ -24,13 +25,15 @@ npm install --save @srgssr/pillarbox-web In your HTML file, add the following code to initialize Pillarbox: ```html + ``` Import the CSS file in your HTML to apply Pillarbox default theme: ```html - + + ``` Finally, import Pillarbox and set up the player: @@ -50,7 +53,6 @@ official [Video.js Player Workflows Guide](https://videojs.com/guides/player-wor More showcases and examples ara available in the [Pillarbox Demo Application](https://srgssr.github.io/pillarbox-web-demo/showcase). - ## Further Reading Pillarbox serves as a superset of video.js, making all the available API features from video.js @@ -60,7 +62,16 @@ class. To learn more about video.js, you can visit the [Video.js Guides](https://videojs.com/guides) and the [Video.js API docs](https://docs.videojs.com/). +To expand the features that Pillarbox offers out of the box, visit the [Pillarbox Web +Suite](https://github.com/SRGSSR/pillarbox-web-suite). You are welcome to contribute and share your +own components there. + Keep track of our [Known Issues](./tutorial-Known%20Issues.html) section. You can learn more about themes and create your own with the [Pillarbox Theme Editor](https://srgssr.github.io/pillarbox-web-theme-editor). + + +[token-settings]: https://github.com/settings/tokens + +[token-guide]: https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#authenticating-with-a-personal-access-token