Skip to content

Commit

Permalink
docs: link to pillarbox-web-suite
Browse files Browse the repository at this point in the history
- Adds links to pillarbox-web-suite to the API documentation and README.
- Add a link to the personal accces token link.
  • Loading branch information
jboix committed Apr 26, 2024
1 parent cadf774 commit 29bd933
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 8 deletions.
19 changes: 15 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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
<link rel="stylesheet" href="node_modules/@srgssr/pillarbox-web/dist/pillarbox.min.css" />
<link rel="stylesheet" href="node_modules/@srgssr/pillarbox-web/dist/pillarbox.min.css"/>
```

Finally, import Pillarbox and set up the player:
Expand All @@ -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).

Expand Down Expand Up @@ -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
19 changes: 15 additions & 4 deletions docs/api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -24,13 +25,15 @@ npm install --save @srgssr/pillarbox-web
In your HTML file, add the following code to initialize Pillarbox:

```html

<video-js id="my-player" class="pillarbox-js" controls crossorigin="anonymous"></video-js>
```

Import the CSS file in your HTML to apply Pillarbox default theme:

```html
<link rel="stylesheet" href="node_modules/@srgssr/pillarbox-web/dist/pillarbox.min.css" />

<link rel="stylesheet" href="node_modules/@srgssr/pillarbox-web/dist/pillarbox.min.css"/>
```

Finally, import Pillarbox and set up the player:
Expand All @@ -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
Expand All @@ -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

0 comments on commit 29bd933

Please sign in to comment.