From 0b793812b93eb1625fcae74bdabd40efc68fd7f8 Mon Sep 17 00:00:00 2001 From: YuShifan <894402575bt@gmail.com> Date: Wed, 30 Aug 2023 15:42:16 +0800 Subject: [PATCH] docs: update markdonw format --- docs/desktop/en/advanced/advanced-setting.md | 4 ++-- docs/desktop/en/quick-start/get-started.md | 12 ++++++------ docs/desktop/en/use-desktop/connect.md | 14 +++++++------- docs/desktop/en/use-desktop/pub-sub.md | 2 +- docs/desktop/zh/advanced/advanced-setting.md | 4 ++-- docs/desktop/zh/quick-start/get-started.md | 5 ++--- docs/desktop/zh/use-desktop/connect.md | 14 +++++++------- docs/desktop/zh/use-desktop/pub-sub.md | 2 +- 8 files changed, 28 insertions(+), 29 deletions(-) diff --git a/docs/desktop/en/advanced/advanced-setting.md b/docs/desktop/en/advanced/advanced-setting.md index 14b10bd85..366065a78 100644 --- a/docs/desktop/en/advanced/advanced-setting.md +++ b/docs/desktop/en/advanced/advanced-setting.md @@ -6,7 +6,7 @@ When you create a new connection, you can configure the advanced settings and se In the Advanced section, you can configure the MQTT protocol-related features. -The default value of the **MQTT Version** is `5.0` and you can configure the MQTT 5.0 specific features such as `Session Expiry Interval`, `Receive Maximum`, and `Topic Alias Maximum` (optional). You can also select other MQTT protocol versions from the drop-down list. Other optional values are `3.1` and `3.1.1`. +The default value of the **MQTT Version** is `5.0` and you can configure the MQTT 5.0 specific features such as `Session Expiry Interval`, `Receive Maximum`, and `Topic Alias Maximum` (optional). You can also select other MQTT protocol versions from the drop-down list. Other optional values are `3.1` and `3.1.1`. For detailed information on the advanced settings, see [Advanced]. @@ -20,4 +20,4 @@ The `Last-Will-QoS` and `Last-Will-Retain` fields are preset with 0 and `False`, ![mqttx-willmessage](/images/mqttx-willmessage.png) -After completing the configuration, click the `Connect` button in the upper right corner to swiftly create a connection and connect to the MQTT Broker. \ No newline at end of file +After completing the configuration, click the `Connect` button in the upper right corner to swiftly create a connection and connect to the MQTT Broker. diff --git a/docs/desktop/en/quick-start/get-started.md b/docs/desktop/en/quick-start/get-started.md index d1ceb33c9..c8711ceaf 100644 --- a/docs/desktop/en/quick-start/get-started.md +++ b/docs/desktop/en/quick-start/get-started.md @@ -26,7 +26,7 @@ You can also try the EMQX Cloud which is a fully managed, cloud-native MQTT Mess ### Self-Managed MQTT Broker -If you want to run an MQTT Broker locally, you are recommended to use [EMQX](https://www.emqx.com/en/products/emqx). It is the world’s most scalable and reliable MQTT messaging platform that can help you to connect, move and process your business data reliably in real time. +If you want to run an MQTT Broker locally, you are recommended to use [EMQX](https://www.emqx.com/en/products/emqx). It is the world’s most scalable and reliable MQTT messaging platform that can help you to connect, move and process your business data reliably in real time. The easiest way to start and run EMQX is using Docker. Follow the steps below for download and installation. @@ -50,7 +50,7 @@ This section demonstrates how to use the MQTTX Desktop to connect to the public 1. Start your MQTT Broker and MQTTX Desktop. You can create a new client connection in either of the following 3 ways: - - Click the **+** icon in the left navigation menu. + - Click the **+** icon in the left navigation menu. - Click the **+ New Connection** button on the main pane. @@ -58,11 +58,11 @@ This section demonstrates how to use the MQTTX Desktop to connect to the public new-connection -2. Enter the connection information of the MQTT broker in the **General** pane. To try a quick connection, you can just enter the name of the new connection, for example, `emqx_test,` and leave other options as default. +2. Enter the connection information of the MQTT broker in the **General** pane. To try a quick connection, you can just enter the name of the new connection, for example, `emqx_test,` and leave other options as default. - If you are using a self-managed MQTT broker, you can replace the hostname with the actual IP, such as `127.0.0.1`. - ::: tip + ::: tip For detailed information about the options in the **General** section, see [Create Connection with Generals Settings](../use-desktop/connect.md). @@ -70,7 +70,7 @@ This section demonstrates how to use the MQTTX Desktop to connect to the public mqttx-brokerinfo -3. Click **Connect** at the upper right corner and now you have established an MQTT client connection named `emqx_test`. +3. Click **Connect** at the upper right corner and now you have established an MQTT client connection named `emqx_test`. mqttx-connected @@ -90,7 +90,7 @@ This section demonstrates how to use the MQTTX Desktop to publish and subscribe 2. Create a new MQTT client connection with the name as `Publisher` by following the steps in [Connect to MQTT Broker](#connect-to-mqtt-broker). -3. In the **Connections** pane, make sure that the client connection `Publisher` is selected. In the publishing area at the lower right corner, enter `test` as the topic and leave the message payload and other options as default. +3. In the **Connections** pane, make sure that the client connection `Publisher` is selected. In the publishing area at the lower right corner, enter `test` as the topic and leave the message payload and other options as default. Click the send button and a number appears on the connection `emqx_test`, indicating that a new message is received. diff --git a/docs/desktop/en/use-desktop/connect.md b/docs/desktop/en/use-desktop/connect.md index 1ace39d5e..2c9afdb24 100644 --- a/docs/desktop/en/use-desktop/connect.md +++ b/docs/desktop/en/use-desktop/connect.md @@ -4,7 +4,7 @@ When you create a new connection, in the **General** section of the **New** pane ## Broker Information -The broker information contains must-fill fields. The **Client ID**, **Host**, and **Port** are already filled with default values. You can modify them based on the actual broker information. +The broker information contains must-fill fields. The **Client ID**, **Host**, and **Port** are already filled with default values. You can modify them based on the actual broker information. - **Name**: Enter a connection, for example `emqx_test`. @@ -49,14 +49,14 @@ You can establish a secured connection between MQTTX and the broker by enabling ::: - - **CA signed server**: Verify the server through the Certificate Authority (CA) signed certificate. + - **CA signed server**: Verify the server through the Certificate Authority (CA) signed certificate. + + - **Self signed**: Verify the server through self-signed certificates. When selected, you need to configure the certificates. For a one-way authentication, only your `CA File` needs to be selected. For two-way authentication, you also need to configure the `Client Certificate File` and `Client key file`. - - **Self signed**: Verify the server through self-signed certificates. When selected, you need to configure the certificates. For a one-way authentication, only your `CA File` needs to be selected. For two-way authentication, you also need to configure the `Client Certificate File` and `Client key file`. - - **CA File**: Select the CA file by clicking the folder icon. - **Client Certificate File**: Select the client certificate file by clicking the folder icon. - **Client key file**: Select the file by clicking the folder icon for two-way authentication. - + mqttx-certs @@ -65,7 +65,7 @@ You can establish a secured connection between MQTTX and the broker by enabling In the Advanced section, you can configure the MQTT protocol-related features. -The default value of the **MQTT Version** is `5.0` and you can configure the MQTT 5.0 specific features such as `Session Expiry Interval`, `Receive Maximum`, and `Topic Alias Maximum` (optional). You can also select other MQTT protocol versions from the drop-down list. Other optional values are `3.1` and `3.1.1`. +The default value of the **MQTT Version** is `5.0` and you can configure the MQTT 5.0 specific features such as `Session Expiry Interval`, `Receive Maximum`, and `Topic Alias Maximum` (optional). You can also select other MQTT protocol versions from the drop-down list. Other optional values are `3.1` and `3.1.1`. For detailed information on the advanced settings, see [Advanced]. @@ -79,4 +79,4 @@ The `Last-Will-QoS` and `Last-Will-Retain` fields are preset with 0 and `False`, ![mqttx-willmessage](/images/mqttx-willmessage.png) -After completing the configuration, click the `Connect` button in the upper right corner to swiftly create a connection and connect to the MQTT Broker. \ No newline at end of file +After completing the configuration, click the `Connect` button in the upper right corner to swiftly create a connection and connect to the MQTT Broker. diff --git a/docs/desktop/en/use-desktop/pub-sub.md b/docs/desktop/en/use-desktop/pub-sub.md index b9ec1ea61..b68b049eb 100644 --- a/docs/desktop/en/use-desktop/pub-sub.md +++ b/docs/desktop/en/use-desktop/pub-sub.md @@ -32,4 +32,4 @@ Through the `payload` option in the message bar, the messages can quickly be con ![mqttx-message](/images/mqttx-message.png) -So far, the testing of an `MQTT` message is completed. \ No newline at end of file +So far, the testing of an `MQTT` message is completed. diff --git a/docs/desktop/zh/advanced/advanced-setting.md b/docs/desktop/zh/advanced/advanced-setting.md index 14b10bd85..366065a78 100644 --- a/docs/desktop/zh/advanced/advanced-setting.md +++ b/docs/desktop/zh/advanced/advanced-setting.md @@ -6,7 +6,7 @@ When you create a new connection, you can configure the advanced settings and se In the Advanced section, you can configure the MQTT protocol-related features. -The default value of the **MQTT Version** is `5.0` and you can configure the MQTT 5.0 specific features such as `Session Expiry Interval`, `Receive Maximum`, and `Topic Alias Maximum` (optional). You can also select other MQTT protocol versions from the drop-down list. Other optional values are `3.1` and `3.1.1`. +The default value of the **MQTT Version** is `5.0` and you can configure the MQTT 5.0 specific features such as `Session Expiry Interval`, `Receive Maximum`, and `Topic Alias Maximum` (optional). You can also select other MQTT protocol versions from the drop-down list. Other optional values are `3.1` and `3.1.1`. For detailed information on the advanced settings, see [Advanced]. @@ -20,4 +20,4 @@ The `Last-Will-QoS` and `Last-Will-Retain` fields are preset with 0 and `False`, ![mqttx-willmessage](/images/mqttx-willmessage.png) -After completing the configuration, click the `Connect` button in the upper right corner to swiftly create a connection and connect to the MQTT Broker. \ No newline at end of file +After completing the configuration, click the `Connect` button in the upper right corner to swiftly create a connection and connect to the MQTT Broker. diff --git a/docs/desktop/zh/quick-start/get-started.md b/docs/desktop/zh/quick-start/get-started.md index a4bfdedd1..fad9ffced 100644 --- a/docs/desktop/zh/quick-start/get-started.md +++ b/docs/desktop/zh/quick-start/get-started.md @@ -33,7 +33,7 @@ EMQX 提供全托管的云原生 MQTT 消息服务，能够通过可靠、实时 ```bash docker run -d --name emqx -p 1883:1883 -p 8083:8083 -p 8084:8084 -p 8883:8883 -p 18083:18083 emqx/emqx-enterprise:latest ``` - + 2. 启动您的 Web 浏览器，输入 `http://localhost:18083/`（`localhost` 可以替换为您的 IP 地址）在地址栏中访问 [EMQX Dashboard](https://docs.emqx.com/zh/enterprise/v5.1/dashboard/introduction.html)，您可以在此连接客户端或查看运行状态。 默认用户名和密码：`admin` 和 `public` @@ -58,13 +58,12 @@ EMQX 提供全托管的云原生 MQTT 消息服务，能够通过可靠、实时 - 如果您使用的是自行部署的 MQTT 服务器，您可以将服务器地址替换为实际的 IP 地址，例如 `127.0.0.1`。 - ::: tip + ::: tip 关于**基础**部分中的选项的详细信息，请查看[使用基础设置创建连接](../use-desktop/connect.md)。 ::: - mqttx-brokerinfo 3. 点击右上角的**连接**。至此，您已经建立了一个名为 `emqx_test` 的 MQTT 客户端连接。 diff --git a/docs/desktop/zh/use-desktop/connect.md b/docs/desktop/zh/use-desktop/connect.md index 1ace39d5e..2c9afdb24 100644 --- a/docs/desktop/zh/use-desktop/connect.md +++ b/docs/desktop/zh/use-desktop/connect.md @@ -4,7 +4,7 @@ When you create a new connection, in the **General** section of the **New** pane ## Broker Information -The broker information contains must-fill fields. The **Client ID**, **Host**, and **Port** are already filled with default values. You can modify them based on the actual broker information. +The broker information contains must-fill fields. The **Client ID**, **Host**, and **Port** are already filled with default values. You can modify them based on the actual broker information. - **Name**: Enter a connection, for example `emqx_test`. @@ -49,14 +49,14 @@ You can establish a secured connection between MQTTX and the broker by enabling ::: - - **CA signed server**: Verify the server through the Certificate Authority (CA) signed certificate. + - **CA signed server**: Verify the server through the Certificate Authority (CA) signed certificate. + + - **Self signed**: Verify the server through self-signed certificates. When selected, you need to configure the certificates. For a one-way authentication, only your `CA File` needs to be selected. For two-way authentication, you also need to configure the `Client Certificate File` and `Client key file`. - - **Self signed**: Verify the server through self-signed certificates. When selected, you need to configure the certificates. For a one-way authentication, only your `CA File` needs to be selected. For two-way authentication, you also need to configure the `Client Certificate File` and `Client key file`. - - **CA File**: Select the CA file by clicking the folder icon. - **Client Certificate File**: Select the client certificate file by clicking the folder icon. - **Client key file**: Select the file by clicking the folder icon for two-way authentication. - + mqttx-certs @@ -65,7 +65,7 @@ You can establish a secured connection between MQTTX and the broker by enabling In the Advanced section, you can configure the MQTT protocol-related features. -The default value of the **MQTT Version** is `5.0` and you can configure the MQTT 5.0 specific features such as `Session Expiry Interval`, `Receive Maximum`, and `Topic Alias Maximum` (optional). You can also select other MQTT protocol versions from the drop-down list. Other optional values are `3.1` and `3.1.1`. +The default value of the **MQTT Version** is `5.0` and you can configure the MQTT 5.0 specific features such as `Session Expiry Interval`, `Receive Maximum`, and `Topic Alias Maximum` (optional). You can also select other MQTT protocol versions from the drop-down list. Other optional values are `3.1` and `3.1.1`. For detailed information on the advanced settings, see [Advanced]. @@ -79,4 +79,4 @@ The `Last-Will-QoS` and `Last-Will-Retain` fields are preset with 0 and `False`, ![mqttx-willmessage](/images/mqttx-willmessage.png) -After completing the configuration, click the `Connect` button in the upper right corner to swiftly create a connection and connect to the MQTT Broker. \ No newline at end of file +After completing the configuration, click the `Connect` button in the upper right corner to swiftly create a connection and connect to the MQTT Broker. diff --git a/docs/desktop/zh/use-desktop/pub-sub.md b/docs/desktop/zh/use-desktop/pub-sub.md index b9ec1ea61..b68b049eb 100644 --- a/docs/desktop/zh/use-desktop/pub-sub.md +++ b/docs/desktop/zh/use-desktop/pub-sub.md @@ -32,4 +32,4 @@ Through the `payload` option in the message bar, the messages can quickly be con ![mqttx-message](/images/mqttx-message.png) -So far, the testing of an `MQTT` message is completed. \ No newline at end of file +So far, the testing of an `MQTT` message is completed.