Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gorhom/docusaurus-react-native-plugin
A plugin to enable React Native Web and Reanimated on Docusaurus.
https://github.com/gorhom/docusaurus-react-native-plugin
docusaurus react-native react-native-web reanimated reanimated2
Last synced: 22 days ago
JSON representation
A plugin to enable React Native Web and Reanimated on Docusaurus.
- Host: GitHub
- URL: https://github.com/gorhom/docusaurus-react-native-plugin
- Owner: gorhom
- License: mit
- Created: 2022-01-02T19:07:07.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2022-01-02T20:03:42.000Z (almost 3 years ago)
- Last Synced: 2024-10-14T10:18:19.909Z (about 1 month ago)
- Topics: docusaurus, react-native, react-native-web, reanimated, reanimated2
- Language: JavaScript
- Homepage:
- Size: 2.93 KB
- Stars: 36
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Docusaurus React Native Plugin
A plugin to enable React Native Web and Reanimated on Docusaurus.
## Installation
```bash
yarn add @gorhom/docusaurus-react-native-plugin -D
```
## Usage
### Monorepo
in the file `docusaurus.config.js` add the following
```js
...
plugins: [
'@gorhom/docusaurus-react-native-plugin',
{
alias: {
'{MY PACKAGE NAME}': path.resolve(
__dirname,
{MY PACKAGE PATH}
),
'react-native-reanimated': path.resolve(
__dirname,
{REANIMATED PACKAGE PATH}
),
},
},
],
...
```
### Standalone
you will need to install the following
```bash
yarn add react-native-web react-native-reanimated
```
then you will need to add the following in the file `docusaurus.config.js`
```js
...
plugins: [
'@gorhom/docusaurus-react-native-plugin',
{
alias: {
'{MY PACKAGE NAME}': path.resolve(
__dirname,
{MY PACKAGE PATH}
),
'react-native-reanimated': path.resolve(
__dirname,
'node_modules/react-native-reanimated'
),
},
},
],
...
```
## License
[MIT](./LICENSE)