Merge pull request #44 from jexjws/patch-1

添加 avante.nvim
2025-01-22 10:35:53 +00:00 · 2024-10-31 11:44:46 +08:00 · 2024-10-31 11:44:46 +08:00 · d5cd63e960
commit d5cd63e960
parent 827b5584dc d5e6d31fa1
4 changed files with 193 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -121,6 +121,16 @@ English/[简体中文](https://github.com/deepseek-ai/awesome-deepseek-integrati
    </tr>
 </table>

+### neovim Extensions
+
+<table>
+    <tr>
+        <td> <img src="https://github.com/user-attachments/assets/d66dfc62-8e69-4b00-8549-d0158e48e2e0" alt="Icon" width="64" height="auto" /> </td>
+        <td> <a href="https://github.com/deepseek-ai/awesome-deepseek-integration/blob/main/docs/avante.nvim/README.md"> avante.nvim </a> </td>
+        <td> avante.nvim is an open-source autopilot in IDE </td>
+    </tr>
+</table>
+
 ### JetBrains Extensions

 <table>
--- a/README_cn.md
+++ b/README_cn.md
@ -119,6 +119,16 @@
    </tr>
 </table>

+### neovim 插件
+
+<table>
+    <tr>
+        <td> <img src="https://github.com/user-attachments/assets/d66dfc62-8e69-4b00-8549-d0158e48e2e0" alt="Icon" width="64" height="auto" /> </td>
+        <td> <a href="https://github.com/deepseek-ai/awesome-deepseek-integration/blob/main/docs/avante.nvim/README_cn.md"> avante.nvim </a> </td>
+        <td> 开源 IDE 插件，使用 LLM 做你的编程助手 </td>
+    </tr>
+</table>
+
 ### 其它

 <table>
--- a/docs/avante.nvim/README.md
+++ b/docs/avante.nvim/README.md
@ -0,0 +1,85 @@
+# [avante.nvim](https://github.com/yetone/avante.nvim)
+
+**avante.nvim** is a Neovim plugin designed to emulate the behaviour of the [Cursor](https://www.cursor.com) AI IDE. It provides users with AI-driven code suggestions and the ability to apply these recommendations directly to their source files with minimal effort.
+
+## Features
+
+- **AI-Powered Code Assistance**: Interact with AI to ask questions about your current code file and receive intelligent suggestions for improvement or modification.
+- **One-Click Application**: Quickly apply the AI's suggested changes to your source code with a single command, streamlining the editing process and saving time.
+
+> [!IMPORTANT]
+> 
+> The project is in rapid iteration, and this guide was last updated on October 19, 2024. Installation and configuration methods may change after this date, so please refer to the original project's README.md for the most accurate information.
+
+## Installation
+
+### Install via `lazy.nvim`
+
+Navigate to the nvim configuration folder (default on Linux is `~/.config/nvim`) and then to the `lua/plugins` folder. Create a file named `avante.lua` and add the following content:
+
+```lua
+return {
+  {
+    "yetone/avante.nvim",
+    event = "VeryLazy",
+    lazy = false,
+    version = false, -- set this if you want to always pull the latest change
+    opts = {
+      provider = "openai",
+      auto_suggestions_provider = "openai", -- Since auto-suggestions are a high-frequency operation and therefore expensive, it is recommended to specify an inexpensive provider or even a free provider: copilot
+      openai = {
+        endpoint = "https://api.deepseek.com/v1",
+        model = "deepseek-chat",
+        timeout = 30000, -- Timeout in milliseconds
+        temperature = 0,
+        max_tokens = 4096,
+        ["local"] = false,
+      },
+    },
+    -- if you want to build from source then do `make BUILD_FROM_SOURCE=true`
+    build = "make",
+    -- build = "powershell -ExecutionPolicy Bypass -File Build.ps1 -BuildFromSource false" -- for windows
+    dependencies = {
+      "nvim-treesitter/nvim-treesitter",
+      "stevearc/dressing.nvim",
+      "nvim-lua/plenary.nvim",
+      "MunifTanjim/nui.nvim",
+      --- The below dependencies are optional,
+      "nvim-tree/nvim-web-devicons", -- or echasnovski/mini.icons
+      "zbirenbaum/copilot.lua", -- for providers='copilot'
+      {
+        -- support for image pasting
+        "HakonHarnes/img-clip.nvim",
+        event = "VeryLazy",
+        opts = {
+          -- recommended settings
+          default = {
+            embed_image_as_base64 = false,
+            prompt_for_file_name = false,
+            drag_and_drop = {
+              insert_mode = true,
+            },
+            -- required for Windows users
+            use_absolute_path = true,
+          },
+        },
+      },
+      {
+        -- Make sure to set this up properly if you have lazy=true
+        'MeanderingProgrammer/render-markdown.nvim',
+        opts = {
+          file_types = { "markdown", "Avante" },
+        },
+        ft = { "markdown", "Avante" },
+      },
+    },
+  },
+}
+```
+Restart nvim, and `lazy.nvim` should automatically download and install the avante.nvim plugin and its dependencies based on the above file.
+
+### Other Installation Methods
+https://github.com/yetone/avante.nvim?tab=readme-ov-file#installation
+
+## Usage
+https://github.com/yetone/avante.nvim?tab=readme-ov-file#usage
--- a/docs/avante.nvim/README_cn.md
+++ b/docs/avante.nvim/README_cn.md
@ -0,0 +1,88 @@
+# [avante.nvim](https://github.com/yetone/avante.nvim)
+
+**avante.nvim** 是一个旨在模拟 [Cursor](https://www.cursor.com) AI IDE 的行为的 Neovim 插件。它为用户提供 AI 驱动的代码建议，并能够以最小的努力将这些建议直接应用于他们的源文件。
+
+## 功能
+
+ - **AI 驱动的代码辅助**：与 AI 聊天以询问有关您当前代码文件的问题，并接收改进或修改的智能建议。
+ - **一键应用**：使用单个命令快速将 AI 建议的更改应用于您的源代码，简化编辑过程并节省时间。
+
+> [!IMPORTANT]
+>
+> 该项目处于快速迭代状态，本指南更新于2024.10.19，在此日期之后的安装配置方法可能会发生变更，请以原项目README.md为准。
+
+
+## 安装
+
+### 通过 `lazy.nvim` 安装
+
+转到nvim的配置文件夹下（linux 默认是`~/.config/nvim`）的 `lua/plugins` 文件夹，创建一个名为 `avante.lua` 的文件，并在其中添加以下内容：   
+```lua
+return {
+    {
+  "yetone/avante.nvim",
+  event = "VeryLazy",
+  lazy = false,
+  version = false, -- set this if you want to always pull the latest change
+  opts = {
+    provider = "openai",
+    auto_suggestions_provider = "openai", -- Since auto-suggestions are a high-frequency operation and therefore expensive, it is recommended to specify an inexpensive provider or even a free provider: copilot
+    openai = {
+    endpoint = "https://api.deepseek.com/v1",
+    model = "deepseek-chat",
+    timeout = 30000, -- Timeout in milliseconds
+    temperature = 0,
+    max_tokens = 4096,
+    ["local"] = false,
+  },
+  },
+  -- if you want to build from source then do `make BUILD_FROM_SOURCE=true`
+  build = "make",
+  -- build = "powershell -ExecutionPolicy Bypass -File Build.ps1 -BuildFromSource false" -- for windows
+  dependencies = {
+    "nvim-treesitter/nvim-treesitter",
+    "stevearc/dressing.nvim",
+    "nvim-lua/plenary.nvim",
+    "MunifTanjim/nui.nvim",
+    --- The below dependencies are optional,
+    "nvim-tree/nvim-web-devicons", -- or echasnovski/mini.icons
+    "zbirenbaum/copilot.lua", -- for providers='copilot'
+    {
+      -- support for image pasting
+      "HakonHarnes/img-clip.nvim",
+      event = "VeryLazy",
+      opts = {
+        -- recommended settings
+        default = {
+          embed_image_as_base64 = faslse,
+          prompt_for_file_name = false,
+          drag_and_drop = {
+            insert_mode = true,
+          },
+          -- required for Windows users
+          use_absolute_path = true,
+        },
+      },
+    },
+    {
+      -- Make sure to set this up properly if you have lazy=true
+      'MeanderingProgrammer/render-markdown.nvim',
+      opts = {
+        file_types = { "markdown", "Avante" },
+      },
+      ft = { "markdown", "Avante" },
+    },
+  },
+},
+}
+```
+
+重启 nvim，此时`lazy.nvim`应该会根据上述文件帮你下载安装好 avante.nvim 插件及其依赖项。
+
+### 其他安装方式
+
+https://github.com/yetone/avante.nvim?tab=readme-ov-file#installation
+
+## 使用
+
+https://github.com/yetone/avante.nvim?tab=readme-ov-file#usage