feat: move docs to github pages (#3296)

* feat(docs): setup nextra

* feat(docs): add pages

* docs: update introduction page

* docs: fix typos

* docs: fix links

* docs: update README

* docs: sync with master

* docs: remove old docs

* fix(ci/docs): fix typos

* fix(ci/docs): fix docs setup

* fix(docs): update next config

* chore(ci/docs): clean up

* chore(docs): add meta tags

* chore: apply review changes

* docs: move drm into api section

* docs: fix next config

* docs: fix links

* docs: add methods section

* chore: sync with main

* docs: add missing onAudio events

README.md

@@ -1,31 +1,50 @@
 # react-native-video
+🎬 `<Video>` component for React Native
 
-> :warning: **Version 6 Alpha**: The following documentation may refer to features only available through the v6.0.0 alpha releases, [please see version 5.2.x](https://github.com/react-native-video/react-native-video/blob/v5.2.0/README.md) for the current documentation!
+> **Note:** version 5.2.1 won't have any updates. We are currently working on making a alpha 6.0.0 stable
 
-## A `<Video>` component for react-native.
-Version 6.x recommends react-native >= 0.68.2. 
-<br>For older versions of react-native, [please use version 5.x](https://github.com/react-native-video/react-native-video/tree/v5.2.0).
+## Documentation
+Documentation is available at [react-native-video.github.io/react-native-video](https://react-native-video.github.io/react-native-video/).
 
-### Version 6.0.0 breaking changes
+## Usage
 
-Version 6.0.0 is introducing dozens of breaking changes, mostly through updated dependecies and significant refactoring. While the API remains compatible, the significant internal changes require full testing with your app to ensure all functionality remains operational. Please view the [Changelog](CHANGELOG.md) for specific breaking changes.
+```javascript
+// Load the module
 
-### Installing Version 6.0.0 Alphas
-Whilst we finalise version 6.0.0 you can install the latest alpha from npm
-Using npm:
-```
-npm install --save react-native-video@alpha
-```
-using yarn:
-```
-yarn add react-native-video@alpha
+import Video, {VideoRef} from 'react-native-video';
+
+// Within your render function, assuming you have a file called
+// "background.mp4" in your project. You can include multiple videos
+// on a single screen if you like.
+
+const VideoPlayer = () => {
+ const videoRef = useRef<VideoRef>(null);
+ const background = require('./background.mp4');
+
+ return (
+   <Video 
+    // Can be a URL or a local file.
+    source={background}
+    // Store reference  
+    ref={videoRef}
+    // Callback when remote video is buffering                                      
+    onBuffer={onBuffer}
+    // Callback when video cannot be loaded              
+    onError={onError}               
+    style={styles.backgroundVideo}
+   />
+ )
+}
+
+// Later on in your styles..
+var styles = StyleSheet.create({
+  backgroundVideo: {
+    position: 'absolute',
+    top: 0,
+    left: 0,
+    bottom: 0,
+    right: 0,
+  },
+});
 ```
 
-## Useful resources
-- [Documentation](API.md)
-- [Changelog](CHANGELOG.md)
-- [Contribution guide](CONTRIBUTING.md)
-- [Usefull Side Project](./docs/PROJECTS.md)
-- [Advanced debugging](./docs/DEBUGGING.md)
-
-**react-native-video** was originally created by [Brent Vatne](https://github.com/brentvatne)