docs: sync with branches changes

This commit is contained in:
Krzysztof Moch
2025-12-22 12:32:29 +01:00
parent 605feed68a
commit b2ea78bd45
7 changed files with 62 additions and 66 deletions
+5 -6
View File
@@ -4,15 +4,14 @@ on:
workflow_dispatch:
push:
branches:
- v7
- master
paths:
# Update on workflow change
- '.github/workflows/deploy-docs.yml'
- ".github/workflows/deploy-docs.yml"
# Update on docs change
- 'docs/**'
- "docs/**"
# Update on code change (Api Reference)
- 'packages/react-native-video/src/**'
- "packages/react-native-video/src/**"
jobs:
build:
@@ -49,4 +48,4 @@ jobs:
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
uses: actions/deploy-pages@v4
+5 -5
View File
@@ -3,14 +3,14 @@ name: Test Documentation Build
on:
pull_request:
branches:
- v7
- master
paths:
# Update on workflow change
- '.github/workflows/test-docs-build.yml'
- ".github/workflows/test-docs-build.yml"
# Update on docs change
- 'docs/**'
- "docs/**"
# Update on code change (Api Reference)
- 'packages/react-native-video/src/**'
- "packages/react-native-video/src/**"
jobs:
test-docs-deploy:
@@ -24,4 +24,4 @@ jobs:
- uses: ./.github/actions/setup-bun
- name: Test build website
run: bun run --cwd docs build
run: bun run --cwd docs build
+1 -2
View File
@@ -41,10 +41,9 @@ The most battle-tested open-source video player component for React Native with
## 📚 Documentation & Examples
- 📖 [Documentation](https://docs.thewidlarzgroup.com/react-native-video)
- 📖 [Documentation](https://docs.thewidlarzgroup.com/react-native-video/docs/v7/intro)
- 📦 [Example: Basic Usage](https://github.com/TheWidlarzGroup/react-native-video/tree/v7/example)
- 📦 [Example: Free DRM Stream](https://www.thewidlarzgroup.com/services/free-drm-token-generator-for-video?utm_source=rnv&utm_medium=readme&utm_id=free-drm)
- 📦 Example: Offline SDK integration - In Progress 🏗️, will be available soon
## 🚀 Quick Start
+3 -4
View File
@@ -1,6 +1,5 @@
{
"lockfileVersion": 1,
"configVersion": 0,
"workspaces": {
"": {
"name": "react-native-video-monorepo",
@@ -52,7 +51,7 @@
},
"example": {
"name": "react-native-video-example",
"version": "7.0.0-beta.1",
"version": "7.0.0-beta.2",
"dependencies": {
"@react-native-community/slider": "^4.5.6",
"@react-native-video/drm": "*",
@@ -80,7 +79,7 @@
},
"packages/drm-plugin": {
"name": "@react-native-video/drm",
"version": "7.0.0-beta.1",
"version": "7.0.0-beta.2",
"devDependencies": {
"@react-native/babel-preset": "0.79.2",
"@release-it/conventional-changelog": "^9.0.2",
@@ -108,7 +107,7 @@
},
"packages/react-native-video": {
"name": "react-native-video",
"version": "7.0.0-beta.1",
"version": "7.0.0-beta.2",
"devDependencies": {
"@expo/config-plugins": "^10.0.2",
"@react-native/eslint-config": "^0.77.0",
+12 -16
View File
@@ -1,23 +1,19 @@
### Build
### Instalation
To install the dependencies, run at the root of the repository:
```
$ bun run build
$ bun install
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Development
To start a local development server with hot-reloading, run:
```
$ bun run start
```
### Deployment
Using SSH:
```
$ USE_SSH=true bun run deploy
```
Not using SSH:
```
$ GIT_USER=<Your GitHub username> bun run deploy
```
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
Deployment is handled via GitHub Actions. Upon pushing to the `master` branch content from the `docs` directory is automatically deployed to GitHub Pages.
+34 -31
View File
@@ -1,58 +1,61 @@
import type { SidebarsConfig } from '@docusaurus/plugin-content-docs';
import type { SidebarsConfig } from "@docusaurus/plugin-content-docs";
const sidebars: SidebarsConfig = {
docsSidebar: [
{
type: 'autogenerated',
dirName: '.',
type: "autogenerated",
dirName: ".",
},
{
type: 'html',
value: '<hr style="margin: 1rem 0; border: none; border-top: 1px solid var(--ifm-color-emphasis-300);" />',
type: "html",
value:
'<hr style="margin: 1rem 0; border: none; border-top: 1px solid var(--ifm-color-emphasis-300);" />',
},
{
type: 'link',
label: 'Example Apps',
href: 'https://github.com/TheWidlarzGroup/react-native-video/tree/master/examples',
type: "link",
label: "Example Apps",
href: "https://github.com/TheWidlarzGroup/react-native-video/tree/master/example",
},
{
type: 'doc',
label: 'Useful Projects',
id: 'projects',
type: "doc",
label: "Useful Projects",
id: "projects",
},
{
type: 'html',
value: '<hr style="margin: 1rem 0; border: none; border-top: 1px solid var(--ifm-color-emphasis-300);" />',
type: "html",
value:
'<hr style="margin: 1rem 0; border: none; border-top: 1px solid var(--ifm-color-emphasis-300);" />',
},
{
type: 'link',
label: 'Offline Video SDK',
href: 'https://www.thewidlarzgroup.com/offline-video-sdk/?utm_source=rnv&utm_medium=docs&utm_campaign=sidebar&utm_id=offline-video-sdk-button',
type: "link",
label: "Offline Video SDK",
href: "https://www.thewidlarzgroup.com/offline-video-sdk/?utm_source=rnv&utm_medium=docs&utm_campaign=sidebar&utm_id=offline-video-sdk-button",
},
{
type: 'link',
label: 'Enterprise Support',
href: 'https://www.thewidlarzgroup.com/?utm_source=rnv&utm_medium=docs&utm_campaign=navbar&utm_id=enterprise#Contact',
type: "link",
label: "Enterprise Support",
href: "https://www.thewidlarzgroup.com/?utm_source=rnv&utm_medium=docs&utm_campaign=navbar&utm_id=enterprise#Contact",
},
{
type: 'link',
label: 'Boost Your Issue',
href: 'https://www.thewidlarzgroup.com/issue-boost/?utm_source=rnv&utm_medium=docs&utm_campaign=sidebar&utm_id=issue-boost-button',
type: "link",
label: "Boost Your Issue",
href: "https://www.thewidlarzgroup.com/issue-boost/?utm_source=rnv&utm_medium=docs&utm_campaign=sidebar&utm_id=issue-boost-button",
},
{
type: 'html',
value: '<hr style="margin: 1rem 0; border: none; border-top: 1px solid var(--ifm-color-emphasis-300);" />',
type: "html",
value:
'<hr style="margin: 1rem 0; border: none; border-top: 1px solid var(--ifm-color-emphasis-300);" />',
},
{
type: 'doc',
label: 'Updating',
id: 'updating',
type: "doc",
label: "Updating",
id: "updating",
},
{
type: 'link',
label: 'Releases',
href: 'https://github.com/TheWidlarzGroup/react-native-video/releases',
}
type: "link",
label: "Releases",
href: "https://github.com/TheWidlarzGroup/react-native-video/releases",
},
],
};
@@ -11,7 +11,7 @@
{
"type": "link",
"label": "Example Apps",
"href": "https://github.com/TheWidlarzGroup/react-native-video/tree/master/examples"
"href": "https://github.com/TheWidlarzGroup/react-native-video/tree/support/6.x.x/examples"
},
{
"type": "doc",
@@ -49,7 +49,7 @@
{
"type": "link",
"label": "Changelog",
"href": "https://github.com/TheWidlarzGroup/react-native-video/blob/master/CHANGELOG.md"
"href": "https://github.com/TheWidlarzGroup/react-native-video/blob/support/6.x.x/CHANGELOG.md"
}
]
}