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"
+    ]
   }
 }

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')],
+};

website/blog/2021-08-30-bottom-sheet-v4.mdx

@@ -0,0 +1,133 @@
+---
+title: BottomSheet v4 is here!
+description: BottomSheet v4 comes with rewritten implementation to provide more stability, performance, and more features.
+slug: bottom-sheet-v4
+authors:
+  - gorhom
+keywords:
+  - bottomsheet
+  - bottom-sheet
+  - bottom sheet
+  - react-native
+  - react native
+  - ios
+  - android
+  - sheet
+  - modal
+  - presentation modal
+  - reanimated
+image: /img/bottom-sheet-preview.gif
+hide_table_of_contents: false
+---
+
+import useBaseUrl from "@docusaurus/useBaseUrl";
+import Video from "@theme/Video";
+
+Today I am releasing the `BottomSheet v4`, with a rewritten implementation to provide more stability, performance, and more features.
+
+## Features
+
+In this release, I have rewritten the implementation to 100% utilize `Reanimated v2` hooks and variables instead of using the JS once. This allows for more customization and provides more stability overall.
+
+### Keyboard Handling
+
+<Video
+  title="React Native Bottom Sheet Keyboard Handling"
+  url={useBaseUrl("video/bottom-sheet-keyboard-handling-preview.mp4")}
+/>
+
+Keyboard handling was released with `v3`, however, there were some issues that pushed this release. Now the keyboard handling is enabled by default and provides more options to customize the behavior, a new prop `android_keyboardInputMode` is introduced to handle the `Android` keyboard appearance config `windowSoftInputMode`.
+
+Read more about [Keyboard Handling](/keyboard-handling).
+
+### Pull to Refresh
+
+<Video
+  title="React Native Bottom Sheet Pull to Refresh"
+  url={useBaseUrl("video/bottom-sheet-pull-to-refresh-preview.mp4")}
+/>
+
+One of the earliest feature request that was submitted to repo [Pull to refresh](https://github.com/gorhom/react-native-bottom-sheet/issues/66) by [gudberg](https://github.com/gudberg). There was an attempt to implement it on `v3` & `v2` but I was hit with their limitations, until now.
+
+This feature is enabled by default, users need to provide `refreshing` & `onRefresh` to any of the [Scrollables](/scrollables) and voila!
+
+Read more about [Pull to Refresh](/pull-to-refresh).
+
+### Detach Sheet / Modal
+
+<Video
+  title="React Native Bottom Sheet Detach Modal"
+  url={useBaseUrl("video/bottom-sheet-detach-preview.mp4")}
+/>
+
+Another powerful addition to `BottomSheet` & `BottomSheetModal` is the ability to detach the sheet from the bottom - so no more bottom sheet 😅 -, which allows users to come up with lots of creative choices and customization to the sheet position.
+
+Read more about [Detach Sheet / Modal](/detach-modal).
+
+### Footer Component
+
+<Video
+  title="React Native Bottom Sheet Custom Footer"
+  url={useBaseUrl("video/bottom-sheet-footer-preview.mp4")}
+/>
+
+Lastly, I have added a new prop `footerComponent` to `BottomSheet` & `BottomSheetModal` to allow users to stick their custom component to the bottom of the sheet even when the keyboard is shown.
+
+Read more about [Footer Component](/custom-footer).
+
+## Breaking changes
+
+#### Removed
+
+- Removed `animationEasing` from `BottomSheet` props.
+- Removed `animationDuration` from `BottomSheet` props.
+- Removed `closeOnPress` from `BottomSheetBackdrop` props.
+- Removed `dismissOnClose` from `BottomSheetModal` props.
+- Removed `enableFlashScrollableIndicatorOnExpand` from `BottomSheet` props.
+
+#### Changes
+
+- `snapPoints` prop is no longer accepting `0` as a value.
+- `animateOnMount` props default value is `true`
+
+## Changelog
+
+Here are the highlight change log of `v4`
+
+#### Refactored
+
+- create one generic scrollable component ([`#442`](https://github.com/gorhom/react-native-bottom-sheet/pull/442)).
+- converted all internal state/memoized variables to reanimated shared values. ([`#430`](https://github.com/gorhom/react-native-bottom-sheet/pull/430)).
+- updated handling animated heights ([`#451`](https://github.com/gorhom/react-native-bottom-sheet/pull/451)).
+
+#### Added
+
+- added pull to refresh implementation ([016a01f](https://github.com/gorhom/react-native-bottom-sheet/commit/016a01f3705c83c9903a3e28c875e7b90424a128)).
+- added enable pan down to close ([`#437`](https://github.com/gorhom/react-native-bottom-sheet/pull/437)).
+- added snap to position ([`#443`](https://github.com/gorhom/react-native-bottom-sheet/pull/443)).
+- added footer component ([`#457`](https://github.com/gorhom/react-native-bottom-sheet/pull/457)).
+- added pre-integrated VirtualizedList component ([2d4d69d](https://github.com/gorhom/react-native-bottom-sheet/commit/2d4d69d8881a3cbe452f5e46157e2b9702528206)).
+- added keyboard input mode for android ([069c4b6](https://github.com/gorhom/react-native-bottom-sheet/commit/069c4b6742630dc5fa7d4763a5c4dc6bfec439cc)).
+- added detached bottom sheet ([`#487`](https://github.com/gorhom/react-native-bottom-sheet/pull/487)).
+- added onClose callback to BottomSheet ([ee64545](https://github.com/gorhom/react-native-bottom-sheet/commit/ee64545ce0e7609fb383f1473773c8481a0bc7aa)).
+- added backgroundStyle, handleStyle & handleIndicatorStyle to bottom sheet ([2211765](https://github.com/gorhom/react-native-bottom-sheet/commit/221176546fd59ed0c9d79fe7f0350eda24dd8550)).
+- added forceClose to BottomSheet methods ([3dd5796](https://github.com/gorhom/react-native-bottom-sheet/commit/3dd5796eb722e4e579de7b2439d224a5e0238b55)).
+
+#### Fixed
+
+- fixed sheet positioning on modals ([ee573e9](https://github.com/gorhom/react-native-bottom-sheet/commit/ee573e9463836301d9736c3e5d86b2b363f9fb14)).
+- fixed prevent animatedPosition from becoming undefined ([400d7b9](https://github.com/gorhom/react-native-bottom-sheet/commit/400d7b93caa0a46f678db2978e7e5f95cc87ee99)).
+- fixed on mount flicker on fixed sheet ([48c4988](https://github.com/gorhom/react-native-bottom-sheet/commit/48c49888b95dc88abf320d4d7590f43806e0bd59)).
+- fixed updated keyboard height in container calculation ([2599f6c](https://github.com/gorhom/react-native-bottom-sheet/commit/2599f6cf46af0f95812e34670de5a7cae5d44fd9)).
+- fixed re-snap to current position when snap points get updated ([bb8e202](https://github.com/gorhom/react-native-bottom-sheet/commit/bb8e202af05dc6beeb108cfa1680401374ac58ad)).
+- fixed handle initial closed sheet ([4bc40d9](https://github.com/gorhom/react-native-bottom-sheet/commit/4bc40d93da05dcff664ce939a9944416b9e91359)).
+
+Read the full [change log](https://github.com/gorhom/react-native-bottom-sheet/blob/master/CHANGELOG.md).
+
+## Special thanks
+
+Thanks to all users for testing and reporting issues. Without your help, this library wouldn't progress this much ❤️
+
+Special thanks to [@kickbk](https://github.com/kickbk), [@vonovak](https://github.com/vonovak), [@likern](https://github.com/likern), [@nandorojo](https://github.com/nandorojo), [@axeldelafosse](https://github.com/axeldelafosse) & [@skdev24](https://github.com/skdev24) for testing & contributing to this release.
+
+Finally, thanks to [Software Mansion](http://swmansion.com/) for powering this library with `Reanimated` & `Gesture Handler`.

website/blog/authors.yml

@@ -0,0 +1,8 @@
+gorhom:
+    name: Mo Gorhom
+    title: Author
+    url: https://github.com/gorhom
+    image_url: https://github.com/gorhom.png
+    socials:
+      x: gorhom
+      github: gorhom