docs: added documentation website

.github/workflows/deployment.yml

@@ -0,0 +1,51 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  build:
+    name: Build Docusaurus
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          cache: yarn
+
+      - name: Install dependencies
+        working-directory: website
+        run: yarn install --frozen-lockfile
+      - name: Build website
+        working-directory: website
+        run: yarn build
+
+      - name: Upload Build Artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: website/build
+
+  deploy:
+    name: Deploy to GitHub Pages
+    needs: build
+
+    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
+    permissions:
+      pages: write # to deploy to Pages
+      id-token: write # to verify the deployment originates from an appropriate source
+
+    # Deploy to the github-pages environment
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -41,7 +41,7 @@ Pods/
 
 # node.js
 #
-node_modules/
+node_modules
 npm-debug.log
 yarn-debug.log
 yarn-error.log
@@ -56,3 +56,24 @@ android/keystores/debug.keystore
 
 # generated by bob
 lib/
+
+# Dependencies
+docs/node_modules
+
+# Production
+docs//build
+
+# Generated files
+docs/.docusaurus
+docs/.cache-loader
+
+# Misc
+docs/.DS_Store
+docs/.env.local
+docs/.env.development.local
+docs/.env.test.local
+docs/.env.production.local
+
+docs/npm-debug.log*
+docs/yarn-debug.log*
+docs/yarn-error.log*

biome.json

@@ -8,9 +8,9 @@
     "indentStyle": "space",
     "lineEnding": "lf",
     "lineWidth": 80,
-    "ignore": ["**/.github", "**/lib", "**/.expo"]
+    "ignore": ["**/.github", "**/lib", "**/.expo", "**/website"]
   },
-  "organizeImports": { "enabled": true },
+  "organizeImports": { "enabled": true, "ignore": ["**/website"] },
   "linter": {
     "enabled": true,
     "rules": {
@@ -73,7 +73,7 @@
         "useValidTypeof": "warn"
       }
     },
-    "ignore": ["**/node_modules/", "**/lib", "**/.expo"]
+    "ignore": ["**/node_modules/", "**/lib", "**/.expo", "**/website"]
   },
   "javascript": {
     "jsxRuntime": "reactClassic",
@@ -100,6 +100,12 @@
     ]
   },
   "files": {
-    "ignore": ["**/node_modules/", "**/lib", "**/.expo", "./example"]
+    "ignore": [
+      "**/node_modules/",
+      "**/lib",
+      "**/.expo",
+      "**/example",
+      "**/website"
+    ]
   }
 }

package.json

@@ -7,7 +7,11 @@
   "types": "lib/typescript/index.d.ts",
   "react-native": "src/index.ts",
   "source": "src/index.ts",
-  "files": ["src", "lib", "mock.js"],
+  "files": [
+    "src",
+    "lib",
+    "mock.js"
+  ],
   "keywords": [
     "react-native",
     "ios",
@@ -37,6 +41,7 @@
     "bootstrap": "yarn install && yarn example"
   },
   "dependencies": {
+    "@docusaurus/theme-search-algolia": "^3.5.2",
     "@gorhom/portal": "1.0.14",
     "invariant": "^2.2.4"
   },
@@ -78,6 +83,10 @@
   "react-native-builder-bob": {
     "source": "src",
     "output": "lib",
-    "targets": ["commonjs", "module", "typescript"]
+    "targets": [
+      "commonjs",
+      "module",
+      "typescript"
+    ]
   }
 }

website/.gitignore

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

website/README.md

@@ -0,0 +1,41 @@
+# Website
+
+This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+Using SSH:
+
+```
+$ USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```
+$ GIT_USER=<Your GitHub username> yarn 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.

website/babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};