This repository provides comprehensive documentation and specifications for the Pillarbox player product, which supports Android, Apple, and Web platforms.
Our goal is to ensure that developers and stakeholders have access to clear and detailed guidelines to facilitate the successful implementation and integration of Pillarbox across various projects.
To access the documentation, please visit: Pillarbox Documentation.
We welcome contributions from everyone. The site is hosted on GitHub Pages and is powered by docsify, served from the public folder in this repository.
Here's a brief overview of the project structure:
- public: This directory serves as the homepage for the docsify site and contains all the documentation files written in markdown.
- public/_sidebar.md: This markdown file renders the sidebar of the page. Add links to your documentation sections here.
To create a new section or document, simply add a file under public and include a link to it in the _sidebar.md file.
Tip
To test the site, simply open public/index.html on your project.
Please adhere to our Contribution Guidelines when making a contribution.
Feel free to open issues, submit pull requests, or share your ideas.
For more information, please refer to the LICENSE file.