chore: bump docusaurus to v3

louisgrasset · Nov 12, 2023 · 5d9d8bc · 5d9d8bc
1 parent 743cf81
commit 5d9d8bc
Show file tree

Hide file tree

Showing 7 changed files with 5,036 additions and 2,357 deletions.
diff --git a/docs/docs/configuration/cron.mdx b/docs/docs/configuration/cron.mdx
@@ -22,7 +22,7 @@ import TipFileGenerator from "./sections/_tip-file-generator.md"
 
 <TipFileGenerator />
 
-Once your env variables are ready, inject them in a .env.{handle_to_sync} file. (e.g: `.env.signalapp`)
+Once your env variables are ready, inject them in a .env.[handle_to_sync] file. (e.g: `.env.signalapp`)
 
 ## Run it!
 
@@ -35,7 +35,7 @@ crontab -e
 
 Then, add the following line to run the sync every 30 minutes:
 ```bash
-*/30 * * * * cd /home/{user}/services/touitmamout && node ./dist/index.js .env
+*/30 * * * * cd /home/[user]/services/touitmamout && node ./dist/index.js .env
 ```
 
 Finally, save and exit the editor.
diff --git a/docs/docs/configuration/manual-sync.mdx b/docs/docs/configuration/manual-sync.mdx
@@ -24,5 +24,5 @@ import TipFileGenerator from "./sections/_tip-file-generator.md"
 
 ## Run it!
 ```bash
-node ./dist/index.js .env.{handle_to_sync}
+node ./dist/index.js .env.[handle_to_sync]
 ```
diff --git a/docs/docs/configuration/pm2.mdx b/docs/docs/configuration/pm2.mdx
@@ -22,13 +22,13 @@ import TipFileGenerator from "./sections/_tip-file-generator.md"
 
 <TipFileGenerator />
 
-Once your env variables are ready, inject them in a .env.{handle_to_sync} file. (e.g: `.env.signalapp`)
+Once your env variables are ready, inject them in a .env.[handle_to_sync] file. (e.g: `.env.signalapp`)
 
 ## Run it!
 
 Touitomamout comes with a script that will automatically handle the PM2 instances management for you.
 
-Simply run the following command, and all your `.env.{handle_to_sync}` files will be used by PM2 to create a dedicated Touitomamout instance for each.
+Simply run the following command, and all your `.env.[handle_to_sync]` files will be used by PM2 to create a dedicated Touitomamout instance for each.
 
 ```bash
 npm run pm2

diff --git a/docs/docs/configuration/sections/_section_pull_install_project.md b/docs/docs/configuration/sections/_section_pull_install_project.md
@@ -1,8 +1,8 @@
-Assuming you have a folder /home/{user}/services
+Assuming you have a folder /home/[user]/services
 
 **Clone** the project
 ```bash
-cd /home/{user}/services && git clone https://github.com/louisgrasset/touitomamout.git
+cd /home/[user]/services && git clone https://github.com/louisgrasset/touitomamout.git
 ```
 
 **Install** dependencies & build the project

diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js
@@ -1,9 +1,10 @@
 /* eslint-disable @typescript-eslint/no-var-requires */
 // @ts-check
 // Note: type annotations allow type checking and IDEs autocompletion
+import { themes } from "prism-react-renderer";
 
-const lightCodeTheme = require("prism-react-renderer/themes/github");
-const darkCodeTheme = require("prism-react-renderer/themes/dracula");
+const lightCodeTheme = themes.github;
+const darkCodeTheme = themes.dracula;
 
 /** @type {import('@docusaurus/types').Config} */
 const config = {

diff --git a/docs/package-lock.json b/docs/package-lock.json
diff --git a/docs/package.json b/docs/package.json
@@ -14,19 +14,19 @@
     "write-heading-ids": "docusaurus write-heading-ids"
   },
   "dependencies": {
-    "@docusaurus/core": "2.4.3",
-    "@docusaurus/preset-classic": "2.4.3",
-    "@mdx-js/react": "^1.6.22",
+    "@docusaurus/core": "3.0.0",
+    "@docusaurus/preset-classic": "3.0.0",
+    "@mdx-js/react": "^3.0.0",
     "@radix-ui/react-icons": "^1.3.0",
     "@radix-ui/themes": "^2.0.0",
-    "clsx": "^1.2.1",
-    "docusaurus-lunr-search": "^3.2.0",
-    "prism-react-renderer": "^1.3.5",
-    "react": "^17.0.2",
-    "react-dom": "^17.0.2"
+    "clsx": "^2.0.0",
+    "docusaurus-lunr-search": "^3.3.0",
+    "prism-react-renderer": "^2.2.0",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "2.4.3"
+    "@docusaurus/module-type-aliases": "3.0.0"
   },
   "browserslist": {
     "production": [