Merge branch 'coder-xiaomo-feature-bump-docusaurus-version'

Author: radex

CONTRIBUTING.md

@@ -1,8 +1,3 @@
----
-title: Contributing
-hide_title: true
----
-
 <img src="https://github.com/Nozbe/WatermelonDB/raw/master/assets/needyou.jpg" alt="We need you" width="220" />
 
 **WatermelonDB is an open-source project and it needs your help to thrive!**

docs-website/blog/2021-08-01-mdx-blog-post.mdx

@@ -7,6 +7,8 @@ tags: [docusaurus]
 
 Blog posts support [Docusaurus Markdown features](https://docusaurus.io/docs/markdown-features), such as [MDX](https://mdxjs.com/).
 
+<!--truncate-->
+
 :::tip
 
 Use the power of React to create interactive blog posts.

docs-website/docs/docs/CHANGELOG.md

@@ -58,7 +58,7 @@ All React/React Native helpers for Watermelon are now available from a new `@noz
 - `DatabaseProvider`, `useDatabase`, `withDatabase`
 - NEW: `withObservables` - `@nozbe/with-observables` as a separate package is deprecated, and is now bundled with WatermelonDB
 - NEW: HOC helpers: `compose`, `withHooks`
-- NEW: `<WithObservables />` component, a component version of `withObservables` HOC. Useful when a value being observed is localized to a small part of a larger component, because you can effortlessly narrow down which parts of the component are re-rendered when the value changes without having to extract a new component.
+- NEW: `&lt;WithObservables />` component, a component version of `withObservables` HOC. Useful when a value being observed is localized to a small part of a larger component, because you can effortlessly narrow down which parts of the component are re-rendered when the value changes without having to extract a new component.
 
 Imports from previous `@nozbe/watermelondb/DatabaseProvider` and `@nozbe/watermelondb/hooks` folders are deprecated and will be removed in a future version.
 
@@ -76,7 +76,7 @@ All debug/dev/diagnostics tools for Watermelon are now available from a new `@no
 
 Changes unlikely to cause issues:
 
-- [iOS] If `import WatermelonDB` is used in your Swift app (for Turbo sync), remove it and replace with `#import <WatermelonDB/WatermelonDB.h>` in the bridging header
+- [iOS] If `import WatermelonDB` is used in your Swift app (for Turbo sync), remove it and replace with `#import &lt;WatermelonDB/WatermelonDB.h>` in the bridging header
 - [iOS] If you use `_watermelonDBLoggingHook`, remove it. No replacement is provided at this time, feel free to contribute if you need this
 - [iOS] If you use `-DENABLE_JSLOCK_PERFORMANCE_HACK`, remove it. JSLockPerfHack has been non-functional for some time already, and has now been removed. Please file an issue if you relied on it.
 
@@ -257,7 +257,7 @@ help to do this! See: https://github.com/Nozbe/WatermelonDB/issues/1481
 ### Fixes
 
 - [TypeScript] Improve typings: add unsafeExecute method, localStorage property to Database
-- [android] Fixed compilation on some setups due to a missing `<cassert>` import
+- [android] Fixed compilation on some setups due to a missing `&lt;cassert>` import
 - [sync] Fixed marking changes as synced for users that don't keep globally unique (only per-table unique) IDs
 - Fix `Model.experimentalMarkAsDeleted/experimentalDestroyPermanently()` throwing an error in some cases
 - Fixes included in updated `withObservables`
@@ -414,7 +414,7 @@ Please don't get scared off the long list of breaking changes - they are all eit
 - [adapters] `onSetUpError: Error => void` option is added to both `SQLiteAdapter` and `LokiJSAdapter`. Supply this option to catch initialization errors and offer the user to reload or log out
 - [LokiJS] new `extraLokiOptions` and `extraIncrementalIDBOptions` options
 - [Android] Autolinking is now supported.
-  - If You upgrade to `<= v0.21.0` **AND** are on a version of React Native which supports Autolinking, you will need to remove the config manually linking WatermelonDB.
+  - If You upgrade to `&lt;= v0.21.0` **AND** are on a version of React Native which supports Autolinking, you will need to remove the config manually linking WatermelonDB.
   - You can resolve this issue by **REMOVING** the lines of config from your project which are _added_ in the `Manual Install ONLY` section of the [Android Install docs](https://nozbe.github.io/WatermelonDB/Installation.html#android-react-native).
 
 ### Performance
@@ -733,7 +733,7 @@ This is a **massive** new update to WatermelonDB! 🍉
 - [withObservables] Improved performance and debuggability (update withObservables package separately)
 - Improved debuggability of Watermelon -- shortened Rx stacks and added function names to aid in understanding
   call stacks and profiles
-- [adapters] The adapters interface has changed. `query()` and `count()` methods now receive a `SerializedQuery`, and `batch()` now takes `TableName<any>` and `RawRecord` or `RecordId` instead of `Model`.
+- [adapters] The adapters interface has changed. `query()` and `count()` methods now receive a `SerializedQuery`, and `batch()` now takes `TableName&lt;any>` and `RawRecord` or `RecordId` instead of `Model`.
 - [Typescript] Typing improvements
   - Added 3 missing properties `collections`, `database` and `asModel` in Model type definition.
   - Removed optional flag on `actionsEnabled` in the Database constructor options since its mandatory since 0.13.0.
@@ -890,13 +890,13 @@ Hotfix for rambdax crash
 ### Changes
 
 - [Android] Changed `compile` to `implementation` in Library Gradle file
-  - ⚠️ might break build if you are using Android Gradle Plugin <3.X
+  - ⚠️ might break build if you are using Android Gradle Plugin &lt;3.X
 - Updated `peerDependency` `react-native` to `0.57.0`
 - [Sync] Added `hasUnsyncedChanges()` helper method
 - [Sync] Improved documentation for backends that can't distinguish between `created` and `updated` records
 - [Sync] Improved diagnostics / protection against edge cases
 - [iOS] Add missing `header search path` to support **ejected** expo project.
-- [Android] Fix crash on android < 5.0
+- [Android] Fix crash on android &lt; 5.0
 - [iOS] `SQLiteAdapter`'s `dbName` path now allows you to pass an absolute path to a file, instead of a name
 - [Web] Add adaptive layout for demo example with smooth scrolling for iOS
 

docs-website/docs/docs/README.md

@@ -57,7 +57,7 @@ Watermelon fixes it **by being lazy**. Nothing is loaded until it's requested. A
 But unlike using SQLite directly, Watermelon is **fully observable**. So whenever you change a record, all UI that depends on it will automatically re-render. For example, completing a task in a to-do app will re-render the task component, the list (to reorder), and all relevant task counters. [**Learn more**](https://www.youtube.com/watch?v=UlZ1QnFF4Cw).
 
 | <a href="https://www.youtube.com/watch?v=UlZ1QnFF4Cw"><img src="https://github.com/Nozbe/WatermelonDB/raw/master/assets/watermelon-talk-thumbnail.jpg" alt="React Native EU: Next-generation React Databases" width="300" /></a> |
-| ---- | --- |
+| ---- |
 | <p align="center"><a href="https://www.youtube.com/watch?v=UlZ1QnFF4Cw">📺 <strong>Next-generation React databases</strong><br/>(a talk about WatermelonDB)</a></p> |
 
 ## Usage

docs-website/docusaurus.config.js

@@ -1,8 +1,9 @@
 // @ts-check
 // Note: type annotations allow type checking and IDEs autocompletion
 
-const lightCodeTheme = require('prism-react-renderer/themes/github')
-const darkCodeTheme = require('prism-react-renderer/themes/dracula')
+const { themes } = require('prism-react-renderer')
+const lightTheme = themes.github
+const darkTheme = themes.dracula
 const { version } = require('./package.json')
 
 /** @type {import('@docusaurus/types').Config} */
@@ -153,8 +154,8 @@ const config = {
         copyright: `WatermelonDB by <a href="https://radex.io">Radek Pietruszewski</a> and <a href="https://nozbe.com">Nozbe</a>.`,
       },
       prism: {
-        theme: lightCodeTheme,
-        darkTheme: darkCodeTheme,
+        theme: lightTheme,
+        darkTheme: darkTheme,
       },
     }),
 }

docs-website/package.json

@@ -14,16 +14,16 @@
     "write-heading-ids": "docusaurus write-heading-ids"
   },
   "dependencies": {
-    "@docusaurus/core": "2.3.0",
-    "@docusaurus/preset-classic": "2.3.0",
-    "@mdx-js/react": "^1.6.22",
+    "@docusaurus/core": "3.7.0",
+    "@docusaurus/preset-classic": "3.7.0",
+    "@mdx-js/react": "^3.0.0",
     "clsx": "^1.2.1",
-    "prism-react-renderer": "^1.3.5",
-    "react": "^17.0.2",
-    "react-dom": "^17.0.2"
+    "prism-react-renderer": "^2.1.0",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "2.3.0"
+    "@docusaurus/module-type-aliases": "3.7.0"
   },
   "browserslist": {
     "production": [
@@ -38,6 +38,6 @@
     ]
   },
   "engines": {
-    "node": ">=16.14"
+    "node": ">=18.0"
   }
 }