Skip to content

update ide quick start doc #421

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/tools/Ide/vs-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,8 @@ This extension provides some coding assistance, including the following features
![Format](/img/docs/tools/Ide/vs-code/Format.gif)
- **Quick fix:** Quick fix some diagnostics
![Qucik Fix](/img/docs/tools/Ide/vs-code/QuickFix.gif)
- **Inlay hint:** Inlay hint displays variable type and other semantic information
![Inlay Hint](/img/docs/tools/Ide/vs-code/Inlayhint.png)

Other useful features such as refactoring and testing are in development.

Expand Down
4 changes: 2 additions & 2 deletions docs/user_docs/getting-started/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -210,12 +210,12 @@ The KCL Extension extension provides some coding assistance, e.g., highlight, go

#### NeoVim

See [here](https://github.com/kcl-lang/kcl.nvim) to config the KCL language server and enable it.
See [here](/docs/tools/Ide/neovim) 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+
We provide two IntelliJ KCL plugins and you can go [here](/docs/tools/Ide/intellij) for more information about the installation.

![intellij](/img/docs/tools/Ide/intellij/overview.png)
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,9 @@ sidebar_position: 1
![Format](/img/docs/tools/Ide/vs-code/Format.gif)
- **快速修复:** 快速修复一些诊断信息
![Qucik Fix](/img/docs/tools/Ide/vs-code/QuickFix.gif)

- **内联提示:** 内链提示变量类型和其他语义信息
![Inlay Hint](/img/docs/tools/Ide/vs-code/Inlayhint.png)

其他一些有用的功能,如代码重构和智能感知等正在开发中。

## 最小依赖
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,6 @@ KCL 为 VS Code 本地版本提供了插件支持,并提供了高亮、自动

#### 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+
我们提供了两个版本的 Intellij 插件。您可以[点击这里](/docs/tools/Ide/vs-code)了解更多。

![intellij](/img/docs/tools/Ide/intellij/overview.png)
Binary file added static/img/docs/tools/Ide/vs-code/Inlayhint.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading