Skip to content

Commit

Permalink
docs: link theme editor in the documentation
Browse files Browse the repository at this point in the history
- Added a link to the theme editor in the API docs and README.
- Added a link to the theme editor repository in the README.
  • Loading branch information
jboix committed Apr 3, 2024
1 parent cc47173 commit 820b6e5
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,8 @@ 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/)
You can create your own theme with
the [Pillarbox Theme Editor](https://srgssr.github.io/pillarbox-web-theme-editor).

## Pillarbox flavours

Expand Down Expand Up @@ -108,6 +110,7 @@ npm run build

If you want to enhance our demo application you can get involved
here: https://github.com/SRGSSR/pillarbox-demo
To contribute to the theme editor go to : https://github.com/SRGSSR/pillarbox-web-theme-editor

## License

Expand Down
3 changes: 3 additions & 0 deletions docs/api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,3 +61,6 @@ To learn more about video.js, you can visit the [Video.js Guides](https://videoj
the [Video.js API docs](https://docs.videojs.com/).

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).
5 changes: 5 additions & 0 deletions docs/api/jsdoc.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,11 @@
"link": "https://srgssr.github.io/pillarbox-web-demo/showcase",
"target": "_blank"
},
{
"title": "Theme Editor",
"link": "https://srgssr.github.io/pillarbox-web-theme-editor",
"target": "_blank"
},
{
"title": "Known Issues",
"link": "./tutorial-Known%20Issues.html",
Expand Down

0 comments on commit 820b6e5

Please sign in to comment.