chore(deps): update docusaurus monorepo to v3 (major) (#522)

* chore(deps): update docusaurus monorepo to v3 * refactor: update packages and content to match Docusaurus update * refactor: fix get started format --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Gao Sun <[email protected]>
logto-io · Nov 23, 2023 · 0c76a5f · 0c76a5f
1 parent ee30130
commit 0c76a5f
Show file tree

Hide file tree

Showing 12 changed files with 3,683 additions and 2,221 deletions.
diff --git a/blog/2022-08-07-typescript-all-in-one.md b/blog/2022-08-07-typescript-all-in-one.md
@@ -79,7 +79,7 @@ Since we are embracing the JavaScript ecosystem and using TypeScript as our main
 
 ### How about schemas?
 
-Something is still missing here: database system and schema <-> TypeScript definition mapping.
+Something is still missing here: database system and schema &lt;-&gt; TypeScript definition mapping.
 
 #### General v.s. opinionated
 
@@ -99,7 +99,7 @@ In conclusion, I decided to stick with Postgres and [Slonik](https://github.com/
 
 > …the benefit of allowing user to choose between the different database dialects is marginal and the overhead of developing for multiple databases at once is significant.
 
-#### SQL <-> TypeScript
+#### SQL &lt;-&gt; TypeScript
 
 Another advantage of writing SQL is we can easily use it as the single source of truth of TypeScript definitions. I wrote a [code generator](https://github.com/logto-io/logto/tree/af7e6ccd83723d623555dafa4650e115fa795838/packages/schemas/src/gen) to transpile SQL schemas to TypeScript code that we’ll use in our backend, and the result looks not bad:
 

diff --git a/blog/releases/2023-mar.md b/blog/releases/2023-mar.md
@@ -94,7 +94,7 @@ The password policy has been updated to require a minimum of 8 characters and co
 
 - Digits: `0-9`
 - Letters: `a-z`, `A-Z`
-- Symbols: <code>!"#$%&'()*+,-./:;<=>?@[]^_`{|}~</code>
+- Symbols: ```!"#$%&'()*+,-./:;<=>?@[]^_`{|}~```
 
 Users must now use at least two out of three types of characters.
 

diff --git a/...recipes/configure-connectors/email-connector/configure-popular-email-service.md b/...recipes/configure-connectors/email-connector/configure-popular-email-service.md
@@ -46,7 +46,7 @@ Notice that:
 
 - Logto provides four different templates for customizing Email content, which are categorized based on their usage type: Register, SignIn, ForgotPassword, and Generic. It is highly recommended that you use different templates for various use cases, or it could trigger flow control, leading to a temporary outage of your service.
 - The verification code is valid for 10 minutes by default.
-- The verification code number sent to users uses the variate of {{code}}.
+- The verification code number sent to users uses the variate of `{{code}}`.
 
 | Usage          | Scenario                                                                                                                                                                |
 | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

diff --git a/docs/docs/recipes/configure-connectors/sms-connector/configure-sms-connector.md b/docs/docs/recipes/configure-connectors/sms-connector/configure-sms-connector.md
@@ -39,14 +39,14 @@ Notice that:
 
 - Logto provides four different templates for customizing SMS content, which are categorized based on their usage type: Register, SignIn, ForgotPassword, and Generic. It is highly recommended that you use different templates for various use cases, or it could trigger flow control, leading to a temporary outage of your service.
 - The verification code is valid for 10 minutes by default.
-- The verification code number sent to users uses the variate of {{code}}.
+- The verification code number sent to users uses the variate of `{{code}}`.
 
 There are some examples just for reference:
 Follow the README to compose the connector config JSON with little effort.
 
-| Usage          | Scenario                                                                                                                                                                | Template Example                                                                                      |
-| -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
-| Register       | Users create an account using their phone number and verify by entering the verification code.                                                                          | Your Logto sign-in verification code is {{code}}. The code will remain active for 10 minutes.         |
-| SignIn         | Users sign in using their phone number and verify by entering verification code instead of entering a password.                                                         | Your Logto sign-up verification code is {{code}}. The code will remain active for 10 minutes.         |
-| ForgotPassword | If users forget their password during sign-in, they can choose to verify their identity using their phone number.                                                       | Your Logto password change verification code is {{code}}. The code will remain active for 10 minutes. |
-| Generic        | This template can be used as a generic backup option for various scenarios, including linking a phone number to an existing account or testing connector configuration… | Your Logto verification code is {{code}}. The code will remain active for 10 minutes.                 |
+| Usage          | Scenario                                                                                                                                                                | Template Example                                                                                                          |
+| -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
+| Register       | Users create an account using their phone number and verify by entering the verification code.                                                                          | Your Logto sign-in verification code is &#123;&#123;code&#125;&#125;. The code will remain active for 10 minutes.         |
+| SignIn         | Users sign in using their phone number and verify by entering verification code instead of entering a password.                                                         | Your Logto sign-up verification code is &#123;&#123;code&#125;&#125;. The code will remain active for 10 minutes.         |
+| ForgotPassword | If users forget their password during sign-in, they can choose to verify their identity using their phone number.                                                       | Your Logto password change verification code is &#123;&#123;code&#125;&#125;. The code will remain active for 10 minutes. |
+| Generic        | This template can be used as a generic backup option for various scenarios, including linking a phone number to an existing account or testing connector configuration… | Your Logto verification code is &#123;&#123;code&#125;&#125;. The code will remain active for 10 minutes.                 |
diff --git a/...-connectors/social-connector/custom-social-connector-with-standard-protocols.md b/...-connectors/social-connector/custom-social-connector-with-standard-protocols.md
@@ -28,7 +28,7 @@ To add a new standard connector in Logto Console, navigate to “**Connector > S
 
 When customizing a standard connector, you will need to configure more general settings, such as the social sign-in button name and logo, and the IdP name.
 
-1. **Name for social sign-in button**: The name of the connector button will be displayed as "Continue with {{name}}." Be mindful of the naming length in case it gets too long.
+1. **Name for social sign-in button**: The name of the connector button will be displayed as "Continue with &#123;&#123;name&#125;&#125;." Be mindful of the naming length in case it gets too long.
 2. **Logo for social sign-in button**: Logto also supports adding different logo images for light and dark modes, with the dark mode logo taking effect after enabling Dark Mode in the Sign-in Experience tab of the Console.
 3. **Identity provider (IdP) name**: IdP name is a unique identifier for each social connector and cannot be changed after it's built.
    1. When configuring a new Standard connector with a new Identity Provider, you just need to enter a unique "IdP name" that hasn't been used before. This will allow you to distinguish the new social connector from others that have been created.

diff --git a/docs/docs/tutorials/get-started/README.mdx b/docs/docs/tutorials/get-started/README.mdx
@@ -19,17 +19,10 @@ During sign-up, you'll go through an onboarding flow that helps Logto understand
 
 ## Logto OSS (self-hosted)
 
-### Launch Logto
+### GitPod
+
+To start an online GitPod workspace for Logto, <a href="https://gitpod.io/#https://github.com/logto-io/demo" target="_blank" rel="noopener">click here</a>. Wait a few moment, you&apos;ll see the message like:
 
-<p>
-  <a href="https://gitpod.io/#https://github.com/logto-io/demo" target="_blank" rel="noopener">
-    Click here
-  </a>
-  &nbsp;
-  <span>
-    to start a GitPod workspace for Logto. Wait a few moment, you&apos;ll see the message like:
-  </span>
-</p>
 <p>
   <img src={gitpodRunning} alt="Gitpod is running" width="720px" />
 </p>

diff --git a/package.json b/package.json
@@ -26,33 +26,33 @@
     "@commitlint/cli": "^18.0.0",
     "@commitlint/config-conventional": "^18.0.0",
     "@commitlint/types": "^18.0.0",
-    "@docusaurus/core": "2.4.3",
-    "@docusaurus/module-type-aliases": "2.4.3",
-    "@docusaurus/preset-classic": "2.4.3",
-    "@docusaurus/theme-classic": "2.4.3",
-    "@docusaurus/theme-common": "2.4.3",
-    "@docusaurus/theme-mermaid": "2.4.3",
-    "@docusaurus/types": "2.4.3",
-    "@mdx-js/react": "^1.6.22",
+    "@docusaurus/core": "3.0.0",
+    "@docusaurus/module-type-aliases": "3.0.0",
+    "@docusaurus/preset-classic": "3.0.0",
+    "@docusaurus/theme-classic": "3.0.0",
+    "@docusaurus/theme-common": "3.0.0",
+    "@docusaurus/theme-mermaid": "3.0.0",
+    "@docusaurus/types": "3.0.0",
+    "@mdx-js/react": "^3.0.0",
     "@silverhand/eslint-config": "^0.17.0",
     "@silverhand/eslint-config-react": "^0.17.0",
     "@silverhand/ts-config": "^0.17.0",
     "@silverhand/ts-config-react": "^0.17.0",
     "@tsconfig/docusaurus": "^1.0.6",
     "@types/node": "^18.11.5",
-    "@types/react": "^17.0.45",
+    "@types/react": "^18.2.38",
     "clsx": "^1.1.1",
     "core-js": "^3.23.0",
-    "docusaurus-plugin-sass": "^0.2.2",
+    "docusaurus-plugin-sass": "^0.2.5",
     "eslint": "^8.17.0",
     "eslint-plugin-mdx": "^2.0.1",
     "husky": "^8.0.1",
     "lint-staged": "^15.0.0",
     "postcss": "^8.4.31",
     "prettier": "^2.7.0",
     "prism-react-renderer": "^1.3.3",
-    "react": "^17.0.2",
-    "react-dom": "^17.0.2",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
     "react-is": "^16.13.1",
     "sass": "^1.52.3",
     "sass-loader": "^13.0.0",