chore: Upgrade Docusaurus to 3.1.1 (#480)

- Upgrade Docusaurus to 3.1.1
- Fix issues with the rendering due to the new version of MDX. Ref: https://docusaurus.io/blog/preparing-your-site-for-docusaurus-v3#preparing-content-for-mdx-v3

.nvmrc

@@ -1 +1 @@
-17.3.0
+20.5.1

docs/contributing-guide/security-reports.md

@@ -7,22 +7,22 @@ Chatwoot is looking forward to working with security researchers worldwide to ke
 
 ## Reporting a Vulnerability
 
-We use [huntr.dev](https://huntr.dev/) for security issues that affect our project. If you believe you have found a vulnerability, please disclose it via this [form](https://huntr.dev/bounties/disclose). 
+We use [huntr.dev](https://huntr.dev) for security issues that affect our project. If you believe you have found a vulnerability, please disclose it via this [form](https://huntr.dev/bounties/disclose).
 
 This will enable us to review the vulnerability, fix it promptly, and reward you for your efforts.
 
-If you have any questions about the process, contact [email protected]. 
+If you have any questions about the process, contact [email protected].
 
 Please try your best to describe a clear and realistic impact for your report, and please don't open any public issues on GitHub or social media; we're doing our best to respond through Huntr as quickly as possible.
 
 > Note: Please use the email for questions related to the process. Disclosures should be done via [huntr.dev](https://huntr.dev/)
 
 ## Supported versions
 
-| Version | Supported        |
-| ------- | --------------   |
-| latest   | ️✅               |
-| <latest   | ❌               |
+| Version  | Supported |
+| -------- | --------- |
+| latest   | ️✅        |
+| < latest | ❌         |
 
 
 ## Vulnerabilities we care about 🫣
@@ -61,19 +61,19 @@ If you are unsure about the scope, please create a [report](https://huntr.dev/re
 
 Chatwoot team triages the issues in Huntr weekly. We're doing our best to respond through Huntr as quickly as we can, So please don't open any public issues on GitHub or social media and avoid duplicate reports over Emails.
 
-- Based on reviewing the report, the team will assign a priority to the issue and move it into the internal backlog to prioritize a fix. 
-- In cases where the team needs more information or disagreements of severity, the team will communicate the same over Huntr before completing the triaging. 
+- Based on reviewing the report, the team will assign a priority to the issue and move it into the internal backlog to prioritize a fix.
+- In cases where the team needs more information or disagreements of severity, the team will communicate the same over Huntr before completing the triaging.
 
 After triage, the team will start working on the issue based on the following Severity and Timelines.
 
-| Severity | Timeline        |
-| ------- | --------------   |
-| Critical (P0)   | ️  7 Days      |
-| High  |    30 Days   |
-| Medium  |  60 Days |
-| Low  | 90 Days|
+| Severity      | Timeline  |
+| ------------- | --------- |
+| Critical (P0) | ️  7 Days |
+| High          | 30 Days   |
+| Medium        | 60 Days   |
+| Low           | 90 Days   |
 
 
 ## Thanks
 
-Thank you for keeping Chatwoot and our users safe. 🙇
+Thank you for keeping Chatwoot and our users safe. 🙇

docs/product/others/help-center/configure-ssl-for-help-center.md

@@ -46,7 +46,7 @@ Once these steps are completed, you will have a portal with articles ready.
 
 1. This process is handled by chatwoot for all the cloud customers.
 2. You need to reach out to us through Chatwoot support with your portal custom domain record.
-3. Or please email us with the subject "Issue SSL certification for {Portal Slug}"
+3. Or please email us with the subject "Issue SSL certification for < Portal Slug >"
 
 #### NOTE: This step will take 1/2 working day/s from the chatwoot team for the setup.
 

docs/self-hosted/deployment/chatwoot-ctl.md

@@ -20,7 +20,7 @@ If `cwctl` is not present, follow the steps below to install Chatwoot CTL.
 
 ### Install or Upgrade Chatwoot CTL
 
-If you used an older version of install script(<2.0), you will not have `cwctl` in your PATH. To install/upgrade Chatwoot CTL,
+If you used an older version of install script(< 2.0), you will not have `cwctl` in your PATH. To install/upgrade Chatwoot CTL,
 
 ```
 wget https://get.chatwoot.app/linux/install.sh -O /usr/local/bin/cwctl && chmod +x /usr/local/bin/cwctl
@@ -31,7 +31,7 @@ cwctl --help
 
 ### Help
 
-To learn more about the options supported by `cwctl`, 
+To learn more about the options supported by `cwctl`,
 ```
 sudo cwctl --help
 ```
@@ -85,7 +85,7 @@ sudo cwctl --logs worker
 
 ### Version
 
-To check the version of Chatwoot CTL, 
+To check the version of Chatwoot CTL,
 
 ```
 sudo cwctl --version

docs/self-hosted/deployment/heroku.md

@@ -5,7 +5,7 @@ title: "Heroku Chatwoot Production deployment guide"
 
 ### Deploying on Heroku
 
-:::Note
+:::note
 Heroku has discontinued free dynos, postgres and redis. https://blog.heroku.com/new-low-cost-plans<br/>
 Chatwoot will switch to using basic/mini plans for all new heroku deployments going forward.
 :::

docs/self-hosted/deployment/linux-vm.md

@@ -71,7 +71,7 @@ Whenever a new version of Chatwoot is released, use the following steps to upgra
 
 To install `cwctl`, refer [this](#install-or-upgrade-chatwoot-cli) section below.
 
-> **Note** If you are on an older version of Chatwoot(<2.7), follow the manual upgrade steps below if you face errors with `cwctl`.
+> **Note** If you are on an older version of Chatwoot(< 2.7), follow the manual upgrade steps below if you face errors with `cwctl`.
 
 Run the following steps on your VM. Make changes based on your OS if you are on a non-Ubuntu system.
 
@@ -146,7 +146,7 @@ journalctl -u chatwoot-worker.1.service -f
 
 ## Install or Upgrade Chatwoot CLI
 
-If you used an older version of install script(<2.0), you will not have `cwctl` in your PATH. To install/upgrade Chatwoot CLI,
+If you used an older version of install script(< 2.0), you will not have `cwctl` in your PATH. To install/upgrade Chatwoot CLI,
 
 ```
 wget https://get.chatwoot.app/linux/install.sh -O /usr/local/bin/cwctl && chmod +x /usr/local/bin/cwctl

docs/self-hosted/deployment/upgrade.md

@@ -9,7 +9,7 @@ Whenever a new version of Chatwoot is released, use the following steps to upgra
 
 > **Note** To install `cwctl`, refer [this](#install-or-upgrade-chatwoot-cli) section below.
 
-> **Note** If you are on an older version of Chatwoot(<2.7), follow the [manual upgrade steps](/docs/self-hosted/deployment/linux-vm#upgrading-to-a-newer-version-of-chatwoot) if you face errors with `cwctl`.
+> **Note** If you are on an older version of Chatwoot(< 2.7), follow the [manual upgrade steps](/docs/self-hosted/deployment/linux-vm#upgrading-to-a-newer-version-of-chatwoot) if you face errors with `cwctl`.
 
 
 ```

docs/user-guide/features/audit-logs.md

@@ -35,66 +35,66 @@ Whenever any of the following activities occurs within your account, an entry is
 
 ### User activity logs
 
-- <_Name | Email_> Changing self status to online, offline, busy
+- *Name | Email* Changing self status to online, offline, busy
 
-- <_Name | Email_> signed in
+- *Name | Email* signed in
 
-- <_Name | Email_> signed out
+- *Name | Email* signed out
 
-- <_Name | Email_> changed the availability status of <_Name | Email_> to <_online | offline | busy_>
+- *Name | Email* changed the availability status of *Name | Email* to *online | offline | busy*
 
-- <_Name | Email_> invited the user <_email_> as an <_agent | admin_>
+- *Name | Email* invited the user *email* as an *agent | admin*
 
-- <_Name | Email_> changed the role of the user <_email_> to <_agent | admin_>
+- *Name | Email* changed the role of the user *email* to *agent | admin*
 
 ### Account activity logs
 
-- <_Name | Email_> updated the account configuration.
+- *Name | Email* updated the account configuration.
 
 ### Automation rule logs
 
-- <_Name | Email_> created a new automation rule (_#rule-id_)
+- *Name | Email* created a new automation rule (_#rule-id_)
 
-- <_Name | Email_> updated an automation rule (#rule-id)
+- *Name | Email* updated an automation rule (#rule-id)
 
-- <_Name | Email_> deleted an automation rule (#_rule-id_)
+- *Name | Email* deleted an automation rule (#_rule-id_)
 
 ### Macro logs
 
-- <_Name | Email_> created a new macro (#_macro-id_)
+- *Name | Email* created a new macro (#_macro-id_)
 
-- <_Name | Email_> updated a macro (#_macro-id_)
+- *Name | Email* updated a macro (#_macro-id_)
 
-- <_Name | Email_> deleted a macro (#_macro-id_)
+- *Name | Email* deleted a macro (#_macro-id_)
 
 ### Inbox logs
 
-- <_Name | Email_> created a new inbox (#_inbox-id_)
+- *Name | Email* created a new inbox (#_inbox-id_)
 
-- <_Name | Email_> updated an inbox (#_inbox-id_)
+- *Name | Email* updated an inbox (#_inbox-id_)
 
-- <_Name | Email_> deleted an inbox (#_inbox-id_)
+- *Name | Email* deleted an inbox (#_inbox-id_)
 
-- <_Name | Email_> added <Name1 | Email1>, <Name2 | Email 2> to the inbox (#_inbox-id_)
+- *Name | Email* added *Name1 | Email1*, *Name2 | Email 2* to the inbox (#_inbox-id_)
 
-- <_Name | Email_> removed <Name1 | Email1>, <Name2 | Email 2> from the inbox (#_inbox-id_)
+- *Name | Email* removed *Name1 | Email1*, *Name2 | Email 2* from the inbox (#_inbox-id_)
 
 ### Webhooks logs
 
-- <_Name | Email_> created a new webhook (#_webook-id_)
+- *Name | Email* created a new webhook (#_webook-id_)
 
-- <_Name | Email_> updated a webhook (#_webhook-id_)
+- *Name | Email* updated a webhook (#_webhook-id_)
 
-- <_Name | Email_> deleted a webhook (#_webhook-id_)
+- *Name | Email* deleted a webhook (#_webhook-id_)
 
 ### Team logs
 
-- <_Name | Email_> created a new team (#_team-id_)
+- *Name | Email* created a new team (#_team-id_)
 
-- <_Name | Email_> updated a team (#_team-id_)
+- *Name | Email* updated a team (#_team-id_)
 
-- <_Name | Email_> deleted a team (#_team-id_)
+- *Name | Email* deleted a team (#_team-id_)
 
-- <_Name | Email_> added <Name1 | Email1>, <Name2 | Email 2> to the team (#_team-id_)
+- *Name | Email* added *Name1 | Email1*, *Name2 | Email 2* to the team (#_team-id_)
 
-- <_Name | Email_> remove <Name1 | Email1>, <Name2 | Email 2> from the team (#_team-id_)
+- *Name | Email* remove *Name1 | Email1*, *Name2 | Email 2* from the team (#_team-id_)

docs/user-guide/features/template-variables.md

@@ -15,7 +15,7 @@ If we send a message `Hey {{ contact.name }}, how may I help you?`, then Chatwoo
 
 ![variable demo](./images/variables/variable-demo.gif)
 
-To use a variable, type two double curly brackets **{{** when composing a new message or creating a canned response. The variables will appear, and you can select the one you'd like to use.
+To use a variable, type two double curly brackets **`{{`** when composing a new message or creating a canned response. The variables will appear, and you can select the one you'd like to use.
 
 
 
@@ -24,18 +24,18 @@ The current list of template variables are:
 
 <div class="table table-striped">
 
-| Variable          | Description                                                           |
-| ----------------- | --------------------------------------------------------------------- |
-| conversation.id | Numeric version of the conversation id |
-| contact.id | Numeric version of the contact id |
-| contact.name | Contact full name |
-| contact.first_name | Contact first name |
-| contact.last_name | Contact last name |
-| contact.phone_number | Contact phone number |
-| agent.name | Agent full name |
-| agent.first_name | Agent first name |
-| agent.last_name | Agent last name |
-| agent.phone_number | Agent phone number |
+| Variable             | Description                            |
+| -------------------- | -------------------------------------- |
+| conversation.id      | Numeric version of the conversation id |
+| contact.id           | Numeric version of the contact id      |
+| contact.name         | Contact full name                      |
+| contact.first_name   | Contact first name                     |
+| contact.last_name    | Contact last name                      |
+| contact.phone_number | Contact phone number                   |
+| agent.name           | Agent full name                        |
+| agent.first_name     | Agent first name                       |
+| agent.last_name      | Agent last name                        |
+| agent.phone_number   | Agent phone number                     |
 </div>
 
 
@@ -52,4 +52,4 @@ If you try to send an undefined variable, then Chatwoot will show a warning.
 
 When defining a fallback text, make sure you surround it with single quotes.
 
-`{{ contact.first_name || 'there'}}`
+`{{ contact.first_name || 'there'}}`

docs/user-guide/setup-your-account/configure-your-profile.md

@@ -18,12 +18,12 @@ This section will help you to update your agent profile on Chatwoot. This update
 
 The fields in the form are described below.
 
-| Field Name | Description |
-| -- | -- |
-| Profile image | A square image that suits your profile. If no image is provided, then the system would take Gravatar Image if available |
-| Your full name | Provide your full name. e.g.: John Hopkins  |
-| Display Name | Provide a name that you want to be displayed on the chat/emails e.g.: `John H` |
-| Your email address | This email address will be used to send notifications, you will be using this email address to login to Chatwoot |
+| Field Name         | Description                                                                                                             |
+| ------------------ | ----------------------------------------------------------------------------------------------------------------------- |
+| Profile image      | A square image that suits your profile. If no image is provided, then the system would take Gravatar Image if available |
+| Your full name     | Provide your full name. e.g.: John Hopkins                                                                              |
+| Display Name       | Provide a name that you want to be displayed on the chat/emails e.g.: `John H`                                          |
+| Your email address | This email address will be used to send notifications, you will be using this email address to login to Chatwoot        |
 
 Click on **Update Profile** to save the changes. If the changes are successful, you will see a message "Your profile has been updated successfully."
 
@@ -37,7 +37,7 @@ You can create your personal message signature. This will get added to all the m
 
 As a security measure, you need to provide your existing password to change the password. If you forgot the old password, you can log out of the system and reset the password.
 
-Password must contain at least one uppercase character (A-Z), at least one numeric character (0..9), and at least one special character `(!@#$%^&*()_+-=[]{}|'"/\^.,`<\>:;?~)`.
+Password must contain at least one uppercase character (A-Z), at least one numeric character (0..9), and at least one special character `(!@#$%^&*()_+-=[]{}|'"/\^.,`\<\>:;?~)`.
 
 <img src={require('./images/configure-your-profile/update-your-password.png').default} width="600" alt="Password Form" />
 

docs/user-guide/setup-your-account/create-an-account.md

@@ -23,13 +23,13 @@ P.S. We have a wholly different [guide](/docs/self-hosted) for self-hosted Chatw
 
 The fields required to signup are as shown below. Fill up the fields.
 
-| Field Name |  Description |
-| -- | -- |
-| Full Name | Enter Your Full name eg: John Hopkins |
-| Work email | Enter a valid work e-mail address eg: *[email protected]*  |
-| Account name | Enter the name of your company eg: Wayne Enterprises |
-| Password  | Password must contain at least one uppercase character (A-Z), at least one numeric character (0..9), and at least one special character `(!@#$%^&*()_+-=[]{}\|'"/\^.,`<\>:;?~)` |
-| Confirm Password | Confirm password should match with the password given above |
+| Field Name       | Description                                                                                                                                                                      |
+| ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Full Name        | Enter Your Full name eg: John Hopkins                                                                                                                                            |
+| Work email       | Enter a valid work e-mail address eg: *[email protected]*                                                                                                             |
+| Account name     | Enter the name of your company eg: Wayne Enterprises                                                                                                                             |
+| Password         | Password must contain at least one uppercase character (A-Z), at least one numeric character (0..9), and at least one special character `(!@#$%^&*()_+-=[]{}\|'"/\^.,`\<\?:;?~)` |
+| Confirm Password | Confirm password should match with the password given above                                                                                                                      |
 
 **Step 3**. After signing up, you would be automatically logged into the dashboard. To complete the signup, you need to verify your email address. You will receive an email with the subject **Confirmation Instructions** from Chatwoot, as shown below.
 
@@ -39,7 +39,7 @@ The fields required to signup are as shown below. Fill up the fields.
 
 ![agent-dashboard](./images/create-an-account/Chatwoot-welcome-screen.png)
 
-Voila! You have verified your account at Chatwoot. 
+Voila! You have verified your account at Chatwoot.
 
 ### Next steps
 
@@ -48,8 +48,8 @@ Follow the steps below to set up your account and get the full power of Chatwoot
 - [Configure your profile](/docs/user-guide/setup-your-account/configure-your-profile): Set your name, picture, password, and more.
 - [Configure account details](/docs/user-guide/setup-your-account/configure-account-details): Setup your account’s name, language, etc.
 - [Add Agents](/docs/user-guide/add-agent-settings): Add your team members to your account to help with managing conversations.
-- [Add Inboxes](/docs/user-guide/add-inbox-settings): Add your conversation inboxes/channels like website widget, Facebook, WhatsApp, etc. 
-- [Configure your chat widget](/docs/user-guide/setting-up-chatwootwidget): Personalize your website chat widget. 
+- [Add Inboxes](/docs/user-guide/add-inbox-settings): Add your conversation inboxes/channels like website widget, Facebook, WhatsApp, etc.
+- [Configure your chat widget](/docs/user-guide/setting-up-chatwootwidget): Personalize your website chat widget.
 - [Add Teams](/docs/user-guide/add-teams-settings): Setup your teams like Sales, Services, Product, etc.
 - [Add Labels](/docs/user-guide/add-label-settings): Setup labels for categorizing your contacts/conversations.
 - [Add Canned Responses](/docs/user-guide/features/canned-responses): Create your saved reply templates for frequently asked questions.

package.json

@@ -14,12 +14,17 @@
     "write-heading-ids": "docusaurus write-heading-ids"
   },
   "dependencies": {
-    "@docusaurus/core": "0.0.0-4784",
-    "@docusaurus/preset-classic": "0.0.0-4784",
-    "@mdx-js/react": "^1.6.21",
-    "clsx": "^1.1.1",
-    "react": "^17.0.1",
-    "react-dom": "^17.0.1"
+    "@docusaurus/core": "3.1.1",
+    "@docusaurus/preset-classic": "3.1.1",
+    "@mdx-js/react": "^3.0.0",
+    "clsx": "^2.0.0",
+    "prism-react-renderer": "^2.3.0",
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0"
+  },
+  "devDependencies": {
+    "@docusaurus/module-type-aliases": "3.1.1",
+    "@docusaurus/types": "3.1.1"
   },
   "browserslist": {
     "production": [