refactor: polish IDE documents.

Peefy · Peefy · commit 72a829748d98 · 2023-08-31T21:37:23.000+08:00
diff --git a/docs/tools/Ide/intellij.md b/docs/tools/Ide/intellij.md
@@ -1,3 +1,9 @@
+---
+sidebar_position: 3
+---
+
 # IntelliJ IDEA
 
-+ IntelliJ Plugin: https://github.com/kcl-lang/intellij-kcl
++ IntelliJ KCL Extension: [https://github.com/kcl-lang/intellij-kcl](https://github.com/kcl-lang/intellij-kcl)
+
+![intellij](/img/docs/tools/Ide/intellij/overview.png)
diff --git a/docs/tools/Ide/neovim.md b/docs/tools/Ide/neovim.md
@@ -0,0 +1,9 @@
+---
+sidebar_position: 2
+---
+
+# NeoVim
+
++ NeoVim KCL Extension: [https://github.com/kcl-lang/kcl.nvim](https://github.com/kcl-lang/kcl.nvim)
+
+![kcl.nvim](/img/docs/tools/Ide/neovim/overview.png)
diff --git a/docs/tools/Ide/vs-code.md b/docs/tools/Ide/vs-code.md
@@ -1,4 +1,8 @@
-# KCL Extension for Visual Studio Code
+---
+sidebar_position: 1
+---
+
+# Visual Studio Code
 
 ## Quick Start
 
diff --git a/docs/user_docs/getting-started/install.md b/docs/user_docs/getting-started/install.md
@@ -127,14 +127,22 @@ GitCommit: {git commit}
 
 For all the above operating systems and installation methods, if you want to use [KCL Python Plugin](/docs/reference/plugin/overview), you need to ensure that Python 3.7+ is installed and add the python3 command to your PATH environment variable.
 
-## 2. Install the KCL IDE Extension
+## 2. Install KCL IDE Extension
 
 ### VS Code
 
 The KCL Extension extension provides some coding assistance, e.g., highlight, goto definition, completion, hover, outline, and diagnostics. You can go [here](/docs/tools/Ide/vs-code) for more information about the installation.
 
 ![Completion](/img/docs/tools/Ide/vs-code/Completion.gif)
 
+### NeoVim
+
+See [here](https://github.com/kcl-lang/kcl.nvim) to config the KCL language server and enable it.
+
+![kcl.nvim](/img/docs/tools/Ide/neovim/overview.png)
+
 ### IntelliJ IDEA
 
 Download the distribution from [here](https://github.com/kcl-lang/intellij-kcl/releases) and in IntelliJ IDEA, click Preference -> plugins -> install Plugin from Disk... -> select kcl-idea-plugin zip -> restart IDE. This plugin requires the IntelliJ IDEA 2020.2+
+
+![intellij](/img/docs/tools/Ide/intellij/overview.png)
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/tools/Ide/intellij.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/tools/Ide/intellij.md
@@ -1,3 +1,9 @@
+---
+sidebar_position: 2
+---
+
 # IntelliJ IDEA
 
-+ IntelliJ Plugin: https://github.com/kcl-lang/intellij-kcl
++ IntelliJ KCL 插件: [https://github.com/kcl-lang/intellij-kcl](https://github.com/kcl-lang/intellij-kcl)
+
+![intellij](/img/docs/tools/Ide/intellij/overview.png)
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/tools/Ide/neovim.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/tools/Ide/neovim.md
@@ -0,0 +1,9 @@
+---
+sidebar_position: 2
+---
+
+# NeoVim
+
++ NeoVim KCL 插件: [https://github.com/kcl-lang/kcl.nvim](https://github.com/kcl-lang/kcl.nvim)
+
+![kcl.nvim](/img/docs/tools/Ide/neovim/overview.png)
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/tools/Ide/vs-code.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/tools/Ide/vs-code.md
@@ -1,4 +1,8 @@
-# Visual Studio Code KCL 插件
+---
+sidebar_position: 1
+---
+
+# Visual Studio Code
 
 ## 快速开始
 
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_docs/getting-started/install.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_docs/getting-started/install.md
@@ -135,6 +135,12 @@ KCL 为 VS Code 本地版本提供了插件支持，并提供了高亮、自动
 
 ![Completion](/img/docs/tools/Ide/vs-code/Completion.gif)
 
+### NeoVim
+
+参见[此处](https://github.com/kcl-lang/kcl.nvim)配置 KCL 语言服务器并启用它。
+
+![kcl.nvim](/img/docs/tools/Ide/neovim/overview.png)
+
 ### IntelliJ IDEA
 
 从[这里](https://github.com/kcl-lang/intellij-kcl/releases)下载发行版，在 IntelliJ IDEA 中，点击 Preference -> plugins -> install Plugin from Disk... -> 选择 kcl-idea-plugin zip -> 重启 IDE。此插件需要 IntelliJ IDEA 2020.2+
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-0.5.5/tools/Ide/intellij.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-0.5.5/tools/Ide/intellij.md
@@ -1,3 +1,9 @@
+---
+sidebar_position: 2
+---
+
 # IntelliJ IDEA
 
-+ IntelliJ Plugin: https://github.com/kcl-lang/intellij-kcl
++ IntelliJ KCL 插件: [https://github.com/kcl-lang/intellij-kcl](https://github.com/kcl-lang/intellij-kcl)
+
+![intellij](/img/docs/tools/Ide/intellij/overview.png)
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-0.5.5/tools/Ide/neovim.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-0.5.5/tools/Ide/neovim.md
@@ -0,0 +1,9 @@
+---
+sidebar_position: 2
+---
+
+# NeoVim
+
++ NeoVim KCL 插件: [https://github.com/kcl-lang/kcl.nvim](https://github.com/kcl-lang/kcl.nvim)
+
+![kcl.nvim](/img/docs/tools/Ide/neovim/overview.png)
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-0.5.5/tools/Ide/vs-code.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-0.5.5/tools/Ide/vs-code.md
@@ -1,4 +1,8 @@
-# Visual Studio Code KCL 插件
+---
+sidebar_position: 1
+---
+
+# Visual Studio Code
 
 ## 快速开始
 
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-0.5.5/user_docs/getting-started/install.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-0.5.5/user_docs/getting-started/install.md
@@ -135,6 +135,12 @@ KCL 为 VS Code 本地版本提供了插件支持，并提供了高亮、自动
 
 ![Completion](/img/docs/tools/Ide/vs-code/Completion.gif)
 
+### NeoVim
+
+参见[此处](https://github.com/kcl-lang/kcl.nvim)配置 KCL 语言服务器并启用它。
+
+![kcl.nvim](/img/docs/tools/Ide/neovim/overview.png)
+
 ### IntelliJ IDEA
 
 从[这里](https://github.com/kcl-lang/intellij-kcl/releases)下载发行版，在 IntelliJ IDEA 中，点击 Preference -> plugins -> install Plugin from Disk... -> 选择 kcl-idea-plugin zip -> 重启 IDE。此插件需要 IntelliJ IDEA 2020.2+
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-0.5.6/tools/Ide/intellij.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-0.5.6/tools/Ide/intellij.md
@@ -1,3 +1,9 @@
+---
+sidebar_position: 2
+---
+
 # IntelliJ IDEA
 
-+ IntelliJ Plugin: https://github.com/kcl-lang/intellij-kcl
++ IntelliJ KCL 插件: [https://github.com/kcl-lang/intellij-kcl](https://github.com/kcl-lang/intellij-kcl)
+
+![intellij](/img/docs/tools/Ide/intellij/overview.png)
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-0.5.6/tools/Ide/neovim.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-0.5.6/tools/Ide/neovim.md
@@ -0,0 +1,9 @@
+---
+sidebar_position: 2
+---
+
+# NeoVim
+
++ NeoVim KCL 插件: [https://github.com/kcl-lang/kcl.nvim](https://github.com/kcl-lang/kcl.nvim)
+
+![kcl.nvim](/img/docs/tools/Ide/neovim/overview.png)
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-0.5.6/tools/Ide/vs-code.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-0.5.6/tools/Ide/vs-code.md
@@ -1,4 +1,8 @@
-# Visual Studio Code KCL 插件
+---
+sidebar_position: 1
+---
+
+# Visual Studio Code
 
 ## 快速开始
 
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-0.5.6/user_docs/getting-started/install.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-0.5.6/user_docs/getting-started/install.md
@@ -135,6 +135,12 @@ KCL 为 VS Code 本地版本提供了插件支持，并提供了高亮、自动
 
 ![Completion](/img/docs/tools/Ide/vs-code/Completion.gif)
 
+### NeoVim
+
+参见[此处](https://github.com/kcl-lang/kcl.nvim)配置 KCL 语言服务器并启用它。
+
+![kcl.nvim](/img/docs/tools/Ide/neovim/overview.png)
+
 ### IntelliJ IDEA
 
 从[这里](https://github.com/kcl-lang/intellij-kcl/releases)下载发行版，在 IntelliJ IDEA 中，点击 Preference -> plugins -> install Plugin from Disk... -> 选择 kcl-idea-plugin zip -> 重启 IDE。此插件需要 IntelliJ IDEA 2020.2+
diff --git a/static/img/docs/tools/Ide/intellij/overview.png b/static/img/docs/tools/Ide/intellij/overview.png
diff --git a/static/img/docs/tools/Ide/neovim/overview.png b/static/img/docs/tools/Ide/neovim/overview.png
diff --git a/versioned_docs/version-0.4.3/user_docs/getting-started/install.md b/versioned_docs/version-0.4.3/user_docs/getting-started/install.md
@@ -62,7 +62,7 @@ docker pull kusionstack/kclvm
 
 > To avoid the GLIBC version being too low, for lower versions of Linux such as Centos7, you can visit [Github](https://github.com/kcl-lang/kcl/releases/) to find the release of kclvm-centos and download and install it.
 
-## 2. Install the KCL IDE Extension
+## 2. Install KCL IDE Extension
 
 ### VS Code
 
diff --git a/versioned_docs/version-0.4.4/user_docs/getting-started/install.md b/versioned_docs/version-0.4.4/user_docs/getting-started/install.md
@@ -102,7 +102,7 @@ docker pull kusionstack/kclvm
 
 > To avoid the GLIBC version being too low, for lower versions of Linux such as Centos7, you can visit [Github](https://github.com/kcl-lang/kcl/releases/) to find the release of kclvm-centos and download and install it.
 
-## 2. Install the KCL IDE Extension
+## 2. Install KCL IDE Extension
 
 ### VS Code
 
diff --git a/versioned_docs/version-0.4.5/user_docs/getting-started/install.md b/versioned_docs/version-0.4.5/user_docs/getting-started/install.md
@@ -111,7 +111,7 @@ docker pull kusionstack/kclvm
 
 > To avoid the GLIBC version being too low, for lower versions of Linux such as Centos7, you can visit [Github](https://github.com/kcl-lang/kcl/releases/) to find the release of kclvm-centos and download and install it.
 
-## 2. Install the KCL IDE Extension
+## 2. Install KCL IDE Extension
 
 ### VS Code
 
diff --git a/versioned_docs/version-0.4.6/user_docs/getting-started/install.md b/versioned_docs/version-0.4.6/user_docs/getting-started/install.md
@@ -95,7 +95,7 @@ docker pull kusionstack/kclvm
 
 > ⚠️ For all the above operating systems and installation methods, if you want to use [KCL Python plug-in](https://kcl-lang.io/docs/reference/plugin/overview), you need to ensure that Python 3.7+ is installed and add the python3 command to your PATH environment variable.
 
-## 2. Install the KCL IDE Extension
+## 2. Install KCL IDE Extension
 
 ### VS Code
 
diff --git a/versioned_docs/version-0.5.0/user_docs/getting-started/install.md b/versioned_docs/version-0.5.0/user_docs/getting-started/install.md
@@ -127,7 +127,7 @@ GitCommit: {git commit}
 
 For all the above operating systems and installation methods, if you want to use [KCL Python Plugin](/docs/reference/plugin/overview), you need to ensure that Python 3.7+ is installed and add the python3 command to your PATH environment variable.
 
-## 2. Install the KCL IDE Extension
+## 2. Install KCL IDE Extension
 
 ### VS Code
 
diff --git a/versioned_docs/version-0.5.1/user_docs/getting-started/install.md b/versioned_docs/version-0.5.1/user_docs/getting-started/install.md
@@ -127,7 +127,7 @@ GitCommit: {git commit}
 
 For all the above operating systems and installation methods, if you want to use [KCL Python Plugin](/docs/reference/plugin/overview), you need to ensure that Python 3.7+ is installed and add the python3 command to your PATH environment variable.
 
-## 2. Install the KCL IDE Extension
+## 2. Install KCL IDE Extension
 
 ### VS Code
 
diff --git a/versioned_docs/version-0.5.2/user_docs/getting-started/install.md b/versioned_docs/version-0.5.2/user_docs/getting-started/install.md
@@ -127,7 +127,7 @@ GitCommit: {git commit}
 
 For all the above operating systems and installation methods, if you want to use [KCL Python Plugin](/docs/reference/plugin/overview), you need to ensure that Python 3.7+ is installed and add the python3 command to your PATH environment variable.
 
-## 2. Install the KCL IDE Extension
+## 2. Install KCL IDE Extension
 
 ### VS Code
 
diff --git a/versioned_docs/version-0.5.3/user_docs/getting-started/install.md b/versioned_docs/version-0.5.3/user_docs/getting-started/install.md
@@ -127,7 +127,7 @@ GitCommit: {git commit}
 
 For all the above operating systems and installation methods, if you want to use [KCL Python Plugin](/docs/reference/plugin/overview), you need to ensure that Python 3.7+ is installed and add the python3 command to your PATH environment variable.
 
-## 2. Install the KCL IDE Extension
+## 2. Install KCL IDE Extension
 
 ### VS Code
 
diff --git a/versioned_docs/version-0.5.4/user_docs/getting-started/install.md b/versioned_docs/version-0.5.4/user_docs/getting-started/install.md
@@ -127,7 +127,7 @@ GitCommit: {git commit}
 
 For all the above operating systems and installation methods, if you want to use [KCL Python Plugin](/docs/reference/plugin/overview), you need to ensure that Python 3.7+ is installed and add the python3 command to your PATH environment variable.
 
-## 2. Install the KCL IDE Extension
+## 2. Install KCL IDE Extension
 
 ### VS Code
 
diff --git a/versioned_docs/version-0.5.5/reference/lang/spec/expressions.md b/versioned_docs/version-0.5.5/reference/lang/spec/expressions.md
@@ -812,8 +812,6 @@ An index expression appearing on the left side of an assignment causes the speci
 ```python
 a = range(3)            # a == [0, 1, 2]
 b = a[2]  # 2
-
-
 ```
 
 It is a dynamic error to attempt to update an element of an immutable type, such as a list or string, or a frozen value of a mutable type.
diff --git a/versioned_docs/version-0.5.5/reference/xlang-api/rest-api.md b/versioned_docs/version-0.5.5/reference/xlang-api/rest-api.md
@@ -176,7 +176,7 @@ message KclErrorInfo {
 }
 
 // ----------------------------------------------------------------------------
-// service requset/response
+// service request/response
 // ----------------------------------------------------------------------------
 
 // gpyrpc.BuiltinService
diff --git a/versioned_docs/version-0.5.5/tools/Ide/intellij.md b/versioned_docs/version-0.5.5/tools/Ide/intellij.md
@@ -1,3 +1,9 @@
+---
+sidebar_position: 3
+---
+
 # IntelliJ IDEA
 
-+ IntelliJ Plugin: https://github.com/kcl-lang/intellij-kcl
++ IntelliJ KCL Extension: [https://github.com/kcl-lang/intellij-kcl](https://github.com/kcl-lang/intellij-kcl)
+
+![intellij](/img/docs/tools/Ide/intellij/overview.png)
diff --git a/versioned_docs/version-0.5.5/tools/Ide/neovim.md b/versioned_docs/version-0.5.5/tools/Ide/neovim.md
@@ -0,0 +1,9 @@
+---
+sidebar_position: 2
+---
+
+# NeoVim
+
++ NeoVim KCL Extension: [https://github.com/kcl-lang/kcl.nvim](https://github.com/kcl-lang/kcl.nvim)
+
+![kcl.nvim](/img/docs/tools/Ide/neovim/overview.png)
diff --git a/versioned_docs/version-0.5.5/tools/Ide/vs-code.md b/versioned_docs/version-0.5.5/tools/Ide/vs-code.md
@@ -1,4 +1,8 @@
-# KCL Extension for Visual Studio Code
+---
+sidebar_position: 1
+---
+
+# Visual Studio Code
 
 ## Quick Start
 
diff --git a/versioned_docs/version-0.5.5/tools/cli/kcl/fmt.md b/versioned_docs/version-0.5.5/tools/cli/kcl/fmt.md
@@ -25,7 +25,7 @@ kcl-fmt your_config_path -R
 ```
 
 * Args
-  * `-R|--recursive` Whether to recursively traverse subfolders
+  * `-R|--recursive` Whether to recursively traverse subfolder
   * `-w|--fmt-output` Whether to output to STDOUT, without `-w` indicates in-place modification.
 
 ## Display of formatting files
diff --git a/versioned_docs/version-0.5.5/tools/cli/kcl/lint.md b/versioned_docs/version-0.5.5/tools/cli/kcl/lint.md
@@ -8,7 +8,7 @@ The KCL Lint tool supports checking some warning-level defects in KCL code and s
 
 ## Example
 
-### Project Struct
+### Project Structure
 
 ```text
 .
diff --git a/versioned_docs/version-0.5.5/tools/cli/openapi/quick-start.md b/versioned_docs/version-0.5.5/tools/cli/openapi/quick-start.md
@@ -8,9 +8,13 @@ sidebar_position: 1
 
 The kcl-openapi tool can be installed in following ways:
 
-- [go install](#11-go-install)
-- [curl|sh install (MacOS & Linux)](#12-curlsh-install-macos--linux)
-- [download from release](#13-dowload-from-release)
+- [Quick Start](#quick-start)
+  - [1. Install KCLOpenAPI Tool](#1-install-kclopenapi-tool)
+  - [1.1 go install](#11-go-install)
+  - [1.2 Curl|sh install (MacOS \& Linux)](#12-curlsh-install-macos--linux)
+  - [1.3 Download from release](#13-download-from-release)
+  - [1.4 Verify your installation](#14-verify-your-installation)
+  - [2. Generate KCL Files](#2-generate-kcl-files)
 
 ## 1.1 go install
 
diff --git a/versioned_docs/version-0.5.5/user_docs/getting-started/install.md b/versioned_docs/version-0.5.5/user_docs/getting-started/install.md
@@ -127,14 +127,22 @@ GitCommit: {git commit}
 
 For all the above operating systems and installation methods, if you want to use [KCL Python Plugin](/docs/reference/plugin/overview), you need to ensure that Python 3.7+ is installed and add the python3 command to your PATH environment variable.
 
-## 2. Install the KCL IDE Extension
+## 2. Install KCL IDE Extension
 
 ### VS Code
 
 The KCL Extension extension provides some coding assistance, e.g., highlight, goto definition, completion, hover, outline, and diagnostics. You can go [here](/docs/tools/Ide/vs-code) for more information about the installation.
 
 ![Completion](/img/docs/tools/Ide/vs-code/Completion.gif)
 
+### NeoVim
+
+See [here](https://github.com/kcl-lang/kcl.nvim) to config the KCL language server and enable it.
+
+![kcl.nvim](/img/docs/tools/Ide/neovim/overview.png)
+
 ### IntelliJ IDEA
 
 Download the distribution from [here](https://github.com/kcl-lang/intellij-kcl/releases) and in IntelliJ IDEA, click Preference -> plugins -> install Plugin from Disk... -> select kcl-idea-plugin zip -> restart IDE. This plugin requires the IntelliJ IDEA 2020.2+
+
+![intellij](/img/docs/tools/Ide/intellij/overview.png)
diff --git a/versioned_docs/version-0.5.6/tools/Ide/intellij.md b/versioned_docs/version-0.5.6/tools/Ide/intellij.md
@@ -1,3 +1,9 @@
+---
+sidebar_position: 3
+---
+
 # IntelliJ IDEA
 
-+ IntelliJ Plugin: https://github.com/kcl-lang/intellij-kcl
++ IntelliJ KCL Extension: [https://github.com/kcl-lang/intellij-kcl](https://github.com/kcl-lang/intellij-kcl)
+
+![intellij](/img/docs/tools/Ide/intellij/overview.png)
diff --git a/versioned_docs/version-0.5.6/tools/Ide/neovim.md b/versioned_docs/version-0.5.6/tools/Ide/neovim.md
@@ -0,0 +1,9 @@
+---
+sidebar_position: 2
+---
+
+# NeoVim
+
++ NeoVim KCL Extension: [https://github.com/kcl-lang/kcl.nvim](https://github.com/kcl-lang/kcl.nvim)
+
+![kcl.nvim](/img/docs/tools/Ide/neovim/overview.png)
diff --git a/versioned_docs/version-0.5.6/tools/Ide/vs-code.md b/versioned_docs/version-0.5.6/tools/Ide/vs-code.md
diff --git a/versioned_docs/version-0.5.6/user_docs/getting-started/install.md b/versioned_docs/version-0.5.6/user_docs/getting-started/install.md
