From 7e136744f6d862b9122840e7721b7467bf74bd60 Mon Sep 17 00:00:00 2001
From: JinmingYang <2214962083@qq.com>
Date: Wed, 31 Jul 2024 23:38:59 +0800
Subject: [PATCH] docs: update doc and slogan
---
README.md | 22 ++++----
README_CN.md | 20 ++++---
package.json | 2 +-
website/.vitepress/config/en.ts | 8 +++
website/.vitepress/config/zh.ts | 8 +++
.../en/guide/configuration/api-concurrency.md | 15 ++++++
website/en/guide/features/ask-ai.md | 2 +-
website/en/guide/features/batch-processor.md | 54 +++++++++++++++++++
website/en/guide/features/copy-as-prompt.md | 2 +-
website/en/guide/getting-started/index.md | 40 ++++++++------
website/en/guide/use-another-llm/ollama.md | 4 +-
website/en/index.md | 6 +--
.../zh/guide/configuration/api-concurrency.md | 15 ++++++
.../configuration/read-clipboard-image.md | 2 +-
website/zh/guide/features/ask-ai.md | 2 +-
website/zh/guide/features/batch-processor.md | 54 +++++++++++++++++++
website/zh/guide/features/copy-as-prompt.md | 2 +-
website/zh/guide/getting-started/index.md | 40 ++++++++------
website/zh/guide/use-another-llm/ollama.md | 4 +-
website/zh/index.md | 6 +--
20 files changed, 235 insertions(+), 73 deletions(-)
create mode 100644 website/en/guide/configuration/api-concurrency.md
create mode 100644 website/en/guide/features/batch-processor.md
create mode 100644 website/zh/guide/configuration/api-concurrency.md
create mode 100644 website/zh/guide/features/batch-processor.md
diff --git a/README.md b/README.md
index 7591f6e..d84441a 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,12 @@
-
Aide
+
AIDE
English / [简体中文 🌏](https://github.com/nicepkg/aide/tree/master/README_CN.md)
-Mastering Any Code In VSCode: One-click commenting and language conversion. 💪
+Conquer Any Code in VSCode: One-Click Comments, Conversions, UI-to-Code, and AI Batch Processing! 💪
-在 VSCode 里掌握任何屎山代码:一键注释和语言转换。💪
+在 VSCode 中征服任何代码:一键注释、转换、UI 图生成代码、AI 批量处理!💪
[![Version](https://img.shields.io/visual-studio-marketplace/v/nicepkg.aide-pro)](https://marketplace.visualstudio.com/items?itemName=nicepkg.aide-pro)
[![Downloads](https://img.shields.io/visual-studio-marketplace/d/nicepkg.aide-pro)](https://marketplace.visualstudio.com/items?itemName=nicepkg.aide-pro)
@@ -25,15 +25,13 @@ https://github.com/user-attachments/assets/55f85f8e-7515-4da3-b850-9c078b3440d5
## Features ✨
-- 🔄 **Code Conversion**: One-click code transformation between languages.
-- 📖 **Code Annotation**: One-click detailed comments for better readability.
-- 📋 **Quick Copy**: Batch copy files/folders as AI prompts.
-- 💬 **Custom Commands**: Execute custom AI commands on selected files.
-- 🔀 **Variable Rename**: Rename variables using AI-suggested variable names.
-- 🎛 **Prompt Templates**: Define flexible AI prompt templates.
-- 📁 **Multi-File Support**: Select multiple files/folders for AI prompts or commands.
-- 🚫 **Ignore Patterns**: Exclude files/folders using custom glob rules.
-- ⌨ **Keyboard Shortcuts**: Set your preferred shortcuts for features.
+- 🔄 **[Code Convert](https://aide.nicepkg.cn/guide/features/code-convert)**: Transform code between any programming languages with one click.
+- 📖 **[Code Viewer Helper](https://aide.nicepkg.cn/guide/features/code-viewer-helper)**: Add detailed comments to enhance code readability.
+- 🔀 **[Smart Paste](https://aide.nicepkg.cn/guide/features/smart-paste)**: Intelligently convert clipboard content (code or images) when pasting.
+- 🤖 **[AI Batch Processor](https://aide.nicepkg.cn/guide/features/batch-processor)**: Process multiple files using AI according to custom requirements.
+- 🏷 **[Rename Variable](https://aide.nicepkg.cn/guide/features/rename-variable)**: Get AI-suggested variable names with explanations.
+- 💬 **[Ask AI](https://aide.nicepkg.cn/guide/features/ask-ai)**: Execute custom AI commands on selected files or folders.
+- 📋 **[Copy as AI Prompt](https://aide.nicepkg.cn/guide/features/copy-as-prompt)**: Easily copy files/folders content as AI prompts.
## Installation 📦
diff --git a/README_CN.md b/README_CN.md
index f02666b..8878323 100644
--- a/README_CN.md
+++ b/README_CN.md
@@ -1,10 +1,10 @@
-
Aide
+AIDE
[English 🌏](https://github.com/nicepkg/aide/tree/master/README.md) / 简体中文
-在 VSCode 里掌握任何屎山代码:一键注释和语言转换。💪
+在 VSCode 中征服任何代码:一键注释、转换、UI 图生成代码、AI 批量处理!💪
[![Version](https://img.shields.io/visual-studio-marketplace/v/nicepkg.aide-pro)](https://marketplace.visualstudio.com/items?itemName=nicepkg.aide-pro)
[![Downloads](https://img.shields.io/visual-studio-marketplace/d/nicepkg.aide-pro)](https://marketplace.visualstudio.com/items?itemName=nicepkg.aide-pro)
@@ -23,15 +23,13 @@ https://github.com/user-attachments/assets/55f85f8e-7515-4da3-b850-9c078b3440d5
## 功能 ✨
-- 🔄 **代码转换**:一键代码语言转换。
-- 📖 **代码注释**:一键添加详细注释,提升可读性。
-- 📋 **快速复制**:批量复制文件/文件夹为 AI 提示。
-- 💬 **自定义命令**:对选定文件执行自定义 AI 命令。
-- 🔀 **变量重命名**:使用 AI 给出的变量名建议重命名变量。
-- 🎛 **提示模板**:定义灵活的 AI 提示模板。
-- 📁 **多文件支持**:选择多个文件/文件夹进行 AI 提示或命令。
-- 🚫 **忽略模式**:使用自定义 glob 规则排除文件/文件夹。
-- ⌨ **快捷键**:设置你偏好的功能快捷键。
+- 🔄 **[代码转换](https://aide.nicepkg.cn/zh/guide/features/code-convert)**: 一键在任何编程语言之间转换代码。
+- 📖 **[代码查看器助手](https://aide.nicepkg.cn/zh/guide/features/code-viewer-helper)**: 添加详细注释以提高代码可读性。
+- 🔀 **[智能粘贴](https://aide.nicepkg.cn/zh/guide/features/smart-paste)**: 粘贴时智能转换剪贴板内容(代码或图片)。
+- 🤖 **[AI 批量处理](https://aide.nicepkg.cn/zh/guide/features/batch-processor)**: 根据自定义要求使用 AI 处理多个文件。
+- 🏷 **[重命名变量](https://aide.nicepkg.cn/zh/guide/features/rename-variable)**: 获取 AI 建议的变量名及解释。
+- 💬 **[问 AI](https://aide.nicepkg.cn/zh/guide/features/ask-ai)**: 对选定的文件或文件夹执行自定义 AI 命令。
+- 📋 **[复制为 AI 提示词](https://aide.nicepkg.cn/zh/guide/features/copy-as-prompt)**: 轻松复制文件/文件夹内容作为 AI 提示。
## 安装 📦
diff --git a/package.json b/package.json
index a2f044b..157602e 100644
--- a/package.json
+++ b/package.json
@@ -2,7 +2,7 @@
"publisher": "nicepkg",
"name": "aide-pro",
"displayName": "Aide",
- "description": "Master Any Code: One-Click Comments and Language Conversion. 掌握任何屎山代码:一键注释和语言转换。💪",
+ "description": "Conquer Any Code in VSCode: One-Click Comments, Conversions, UI-to-Code, and AI Batch Processing! 在 VSCode 中征服任何代码:一键注释、转换、UI 图生成代码、AI 批量处理!💪",
"version": "1.16.0",
"private": true,
"packageManager": "pnpm@9.3.0",
diff --git a/website/.vitepress/config/en.ts b/website/.vitepress/config/en.ts
index 5c10146..81955b7 100644
--- a/website/.vitepress/config/en.ts
+++ b/website/.vitepress/config/en.ts
@@ -88,6 +88,10 @@ function sidebar(): DefaultTheme.Sidebar {
text: 'Smart Paste',
link: '/smart-paste'
},
+ {
+ text: 'AI Batch Processor',
+ link: '/batch-processor'
+ },
{
text: 'Copy Multiple Files As Prompt',
link: '/copy-as-prompt'
@@ -113,6 +117,10 @@ function sidebar(): DefaultTheme.Sidebar {
text: 'aide.openaiBaseUrl',
link: '/openai-base-url'
},
+ {
+ text: 'aide.apiConcurrency',
+ link: '/api-concurrency'
+ },
{
text: 'aide.useSystemProxy',
link: '/use-system-proxy'
diff --git a/website/.vitepress/config/zh.ts b/website/.vitepress/config/zh.ts
index 08762e9..066b818 100644
--- a/website/.vitepress/config/zh.ts
+++ b/website/.vitepress/config/zh.ts
@@ -112,6 +112,10 @@ function sidebar(): DefaultTheme.Sidebar {
text: '智能粘贴',
link: '/smart-paste'
},
+ {
+ text: 'AI 批量处理',
+ link: '/batch-processor'
+ },
{
text: '批量复制文件为 AI 提示词',
link: '/copy-as-prompt'
@@ -143,6 +147,10 @@ function sidebar(): DefaultTheme.Sidebar {
text: 'aide.openaiBaseUrl',
link: '/openai-base-url'
},
+ {
+ text: 'aide.apiConcurrency',
+ link: '/api-concurrency'
+ },
{
text: 'aide.useSystemProxy',
link: '/use-system-proxy'
diff --git a/website/en/guide/configuration/api-concurrency.md b/website/en/guide/configuration/api-concurrency.md
new file mode 100644
index 0000000..6aa82a9
--- /dev/null
+++ b/website/en/guide/configuration/api-concurrency.md
@@ -0,0 +1,15 @@
+# aide.apiConcurrency
+
+This configuration allows you to customize the AI request concurrency, which is `1` by default. It is recommended not to change it when using local models.
+
+- **Default Value:**
+
+ ```json
+ {
+ "aide.apiConcurrency": 1
+ }
+ ```
+
+::: tip
+You can increase this number to speed up the [`AI Batch Processing`](../features/batch-processor.md). It is not recommended to exceed `3`.
+:::
diff --git a/website/en/guide/features/ask-ai.md b/website/en/guide/features/ask-ai.md
index 5bc3186..a26eda8 100644
--- a/website/en/guide/features/ask-ai.md
+++ b/website/en/guide/features/ask-ai.md
@@ -6,7 +6,7 @@ Prepare and execute a custom AI command based on the selected file and user inpu
**Usage:**
-- Select a file or folder in the explorer.
+- Select a file or folder in the explorer. (Multi-select: hold `Ctrl` or `Cmd` and click on files or folders)
- Right-click and select `✨ Aide: Ask AI`.
- Follow the prompt to enter your question.
diff --git a/website/en/guide/features/batch-processor.md b/website/en/guide/features/batch-processor.md
new file mode 100644
index 0000000..bcc2c8f
--- /dev/null
+++ b/website/en/guide/features/batch-processor.md
@@ -0,0 +1,54 @@
+# AI Batch Processor
+
+Command Name: `aide.batchProcessor`
+
+Use AI to process the code of multiple selected files according to your needs.
+
+**What it can do:**
+
+- Batch add detailed comments
+- Batch optimize code
+- Batch convert `vue2` code to `vue3` code
+- Batch convert `vue` code to `react` code
+- Batch convert `react` code to `flutter` code
+- Batch convert `react class component` code to `react function component` code
+- Batch convert `rust` code to `js` code
+- Batch convert `json` code to `yaml` code
+- Use your imagination...
+
+**What it cannot do:**
+
+- Specific business requirements
+- Split one file into multiple files
+
+**Rest assured! Processing will not modify the `source file`:**
+
+- It will generate an additional `file copy`. For example, `app/index.py` -> `app/index.py.aide.py`.
+- You can click the `file copy`, review it, and then decide whether to replace the `source file`.
+- When opening the `file copy`, the `source file` will be opened simultaneously, allowing you to compare at any time.
+- You can click the `Replace Original` button on the first line of the `file copy` to replace the `source file`.
+
+**Usage:**
+
+- Select files or folders in the file explorer. (Multi-select: hold `Ctrl` or `Cmd` and click on files or folders)
+- Right-click and select `✨ Aide: AI Batch Processor`.
+- Enter your code processing requirements.
+
+::: warning
+
+This feature requires the AI model to support the `function_call` feature.
+
+:::
+
+
+
+::: tip
+
+1. For long file codes, there may be issues with output interruption. Currently, there is no good solution.
+2. Carefully review the processed files to ensure they are correct before replacing the source files. Never assume that AI-processed code is error-free.
+
+:::
+
+**Related Configuration:**
+
+- You can customize the AI request concurrency by modifying the [`aide.apiConcurrency`](../configuration/api-concurrency.md) configuration.
diff --git a/website/en/guide/features/copy-as-prompt.md b/website/en/guide/features/copy-as-prompt.md
index dc7dff7..0b4e17f 100644
--- a/website/en/guide/features/copy-as-prompt.md
+++ b/website/en/guide/features/copy-as-prompt.md
@@ -6,7 +6,7 @@ Copies the content of the selected files to the clipboard and formats it as AI i
**Usage:**
-- Select files or folders in the explorer.
+- Select files or folders in the explorer. (Multi-select: hold `Ctrl` or `Cmd` and click on files or folders)
- Right-click and select `✨ Aide: Copy as AI Prompt`.
diff --git a/website/en/guide/getting-started/index.md b/website/en/guide/getting-started/index.md
index 2ea9d32..299bba3 100644
--- a/website/en/guide/getting-started/index.md
+++ b/website/en/guide/getting-started/index.md
@@ -5,41 +5,47 @@
## Why Choose `Aide`?
-- **😩 Are you suffering from reading through the messy code left by your predecessors?**
+`Aide` is a powerful AI-assisted development `VSCode` extensions designed to enhance your coding experience. Here's why you should choose `Aide`:
- ✅ `Aide` can add detailed comments to your code with one click, outputting to a temporary file for you to review, thereby improving code readability.
+- **📚 Improved Code Readability**: Add detailed comments to your code with one click, improving readability without modifying the original file.
-- **🆕 Are you learning a new language or reading a project in an unfamiliar language and wish to understand the new code in a familiar language?**
+- **🔄 Effortless Code Conversion**: Convert code between languages or frameworks instantly, making it easier to understand unfamiliar code or migrate projects.
- ✅ `Aide` can convert code into a familiar language with one click, outputting to a temporary file so you can immediately understand its logic.
+- **🔮 Magical Smart Paste**: Intelligently convert clipboard content when pasting, including transforming design screenshots into UI code. Streamlines cross-language, cross-framework development, and design-to-code workflows.
-- **📋 Do you have to manually copy multiple file codes and paste them into an AI website for questions every time?**
+- **📋 Efficient Batch Processing**: Easily process multiple files or folders with AI, significantly boosting your productivity.
- ✅ `Aide` allows you to batch copy multiple files or folders with one click, saving you a lot of time.
+- **🏷️ Intelligent Variable Renaming**: Get AI-powered variable name suggestions with explanations, helping you choose the best names for your code.
-- **🤔 Are you always dissatisfied with your variable names?**
+- **🤖 Customizable AI Commands**: Create and execute custom AI commands, allowing for flexible interaction with your codebase.
- ✅ `Aide` can use AI to provide variable name suggestions and explanations, allowing you to choose the best practice variable names and make your code more standardized.
+## Key Features
-- **🔄 Do you often need to convert code from one format to another before pasting it into your project?**
+1. **[Code Viewer Helper](../features/code-viewer-helper.md)**: Add AI-generated comments to make your code easier to understand.
- ✅ `Aide` can intelligently recognize code in the clipboard and guess your intent for smart pasting. For example, if you copy a `JSON` and paste it into a `TypeScript` file, it will automatically convert it to a `TypeScript` type. Or if you copy `Tailwind CSS` code and paste it into a `Flutter Dart` file, it will automatically convert it to a `Flutter Widget`, saving you a lot of time.
+2. **[Code Convert](../features/code-convert.md)**: Transform code from one programming language to another with AI assistance.
-- **⌨️ When using command line tools similar to [`aider`](https://github.com/paul-gauthier/aider), do you dislike entering file paths one by one?**
+3. **[Smart Paste](../features/smart-paste.md)**: Intelligently convert clipboard content when pasting into different file types.
- ✅ `Aide` allows you to customize AI command execution templates, passing selected file paths to the AI command, significantly saving your time.
+4. **[AI Batch Processor](../features/batch-processor.md)**: Process multiple files with AI according to your specific requirements
+
+5. **[Copy Multiple Files As AI Prompt](../features/copy-as-prompt.md)**: Format multiple files as AI interaction prompts with a single click.
+
+6. **[Rename Variable](../features/rename-variable.md)**: Get AI suggestions for variable names to improve code clarity.
+
+7. **[Ask AI With Custom Command](../features/ask-ai.md)**: Execute customized AI commands on selected files or folders.
## Differences Between `Aide` and `Copilot/Codeium/AmazonQ`
-- **🚫 No Redundant Features**: We won't create a sidebar for AI chat, nor will we provide AI auto-completion features, because these are already offered by other tools. We only provide features that we can do better. `Aide` is a supplement, not a replacement.
+- **🚫 No Redundant Features**: We focus on unique, complementary features rather than replicating existing tools.
-- **⚡ Focus on Efficiency and Practicality**: `Aide` focuses on providing more efficient AI features and more practical interaction methods. Each feature is deeply thought out and designed by the author to ensure a good user experience.
+- **⚡ Efficiency-Focused**: Each feature is carefully designed for optimal user experience and practical utility.
-- **❌ No Poor-Performing Features**: `Aide` will not offer features with poor performance, such as embedding an entire project into an AI and asking it questions. Such features usually perform poorly, so we won't offer them.
+- **💪 Quality Over Quantity**: We prioritize high-performing features, avoiding those with poor real-world results.
-- **🔓 Open Source**: `Aide` is open source, allowing you to freely view the source code.
+- **🔓 Open Source**: Freely view and contribute to our source code.
-- **🛠️ Customizable**: `Aide` allows you to customize the AI model and even use local models.
+- **🛠️ Customizable**: Use your preferred AI model, including local options.
## Quick Navigation
diff --git a/website/en/guide/use-another-llm/ollama.md b/website/en/guide/use-another-llm/ollama.md
index 3eeac80..c132ee1 100644
--- a/website/en/guide/use-another-llm/ollama.md
+++ b/website/en/guide/use-another-llm/ollama.md
@@ -20,7 +20,7 @@ You can configure [`aide.openaiKey`](../configuration/openai-key.md) with any va
### Model Configuration
-You need to configure [`aide.openaiModel`](../configuration/openai-model.md) to the `Ollama` model. We recommend using the `gemma2` model. For more models, please refer to the [Supported Models List](https://ollama.com/library).
+You need to configure [`aide.openaiModel`](../configuration/openai-model.md) to the `Ollama` model. We recommend using the `llama3.1` model. For more models, please refer to the [Supported Models List](https://ollama.com/library).
### Example Configuration File
@@ -30,7 +30,7 @@ Below is a complete configuration example:
{
"aide.openaiBaseUrl": "http://localhost:11434/v1",
"aide.openaiKey": "sk-ollama",
- "aide.openaiModel": "gemma2"
+ "aide.openaiModel": "llama3.1"
}
```
diff --git a/website/en/index.md b/website/en/index.md
index 636fd4a..c58c2d2 100644
--- a/website/en/index.md
+++ b/website/en/index.md
@@ -2,13 +2,13 @@
layout: home
title: Aide
-titleTemplate: Mastering Any Code In VSCode
+titleTemplate: Conquer Any Code in VSCode
hero:
name: Aide
image: /logo.svg
- text: 'Mastering Any Code In VSCode 💪'
- tagline: 'One-click commenting and language conversion.'
+ text: 'Conquer Any Code in VSCode 💪'
+ tagline: 'One-Click Comments, Conversions, UI-to-Code, and AI Batch Processing!'
actions:
- theme: brand
text: Get Started
diff --git a/website/zh/guide/configuration/api-concurrency.md b/website/zh/guide/configuration/api-concurrency.md
new file mode 100644
index 0000000..7c9b186
--- /dev/null
+++ b/website/zh/guide/configuration/api-concurrency.md
@@ -0,0 +1,15 @@
+# aide.apiConcurrency
+
+此配置允许您自定义 AI 请求并发数,默认是 `1`,用本地模型的最好不要改。
+
+- **默认值:**
+
+ ```json
+ {
+ "aide.apiConcurrency": 1
+ }
+ ```
+
+::: tip 提示
+你可以通过改大这个数目来提升 [`AI 批量处理`](../features/batch-processor.md) 的速度。不建议超过 `3`。
+:::
diff --git a/website/zh/guide/configuration/read-clipboard-image.md b/website/zh/guide/configuration/read-clipboard-image.md
index cefc22c..bb7f731 100644
--- a/website/zh/guide/configuration/read-clipboard-image.md
+++ b/website/zh/guide/configuration/read-clipboard-image.md
@@ -20,4 +20,4 @@
目前支持以下场景:
-- [`智能粘贴`](../features//smart-paste.md)
+- [`智能粘贴`](../features/smart-paste.md)
diff --git a/website/zh/guide/features/ask-ai.md b/website/zh/guide/features/ask-ai.md
index 416eca8..6205221 100644
--- a/website/zh/guide/features/ask-ai.md
+++ b/website/zh/guide/features/ask-ai.md
@@ -6,7 +6,7 @@
**使用方法:**
-- 在资源管理器中选择文件或文件夹。
+- 在资源管理器中选择文件或文件夹。(多选方法:按住 `Ctrl` 或 `Cmd` 并点击文件或文件夹)
- 右键选择 `✨ Aide: 问 AI`。
- 按提示输入您的问题。
diff --git a/website/zh/guide/features/batch-processor.md b/website/zh/guide/features/batch-processor.md
new file mode 100644
index 0000000..5deed81
--- /dev/null
+++ b/website/zh/guide/features/batch-processor.md
@@ -0,0 +1,54 @@
+# AI 批量处理
+
+命令名称: `aide.batchProcessor`
+
+使用 AI 将选中的多个文件代码根据你的需求处理。
+
+**它能做的:**
+
+- 批量加上详细注释
+- 批量优化代码
+- 批量将 `vue2` 代码转换为 `vue3` 代码
+- 批量将 `vue` 代码转换为 `react` 代码
+- 批量将 `react` 代码转换为 `flutter` 代码
+- 批量将 `react class component` 代码转换为 `react function component` 代码
+- 批量将 `rust` 代码转换为 `js` 代码
+- 批量将 `json` 代码转换为 `yaml` 代码
+- 发挥想像力..
+
+**它不能做的:**
+
+- 具体的业务需求
+- 一个文件拆分成多个文件
+
+**放心!处理并不会修改`源文件`:**
+
+- 它会额外生成`文件副本`。比如 `app/index.py` -> `app/index.py.aide.py`。
+- 你可以点击`文件副本`,审查无误后再决定是否替换`源文件`。
+- 打开`文件副本`时会同时打开`源文件`,以便你可以随时对比。
+- 你可以点击`文件副本`第一行的 `替换原文` 按钮来替换`源文件`。
+
+**使用方法:**
+
+- 在资源管理器中选择文件或文件夹。(多选方法:按住 `Ctrl` 或 `Cmd` 并点击文件或文件夹)
+- 右键选择 `✨ Aide: AI 批量处理`。
+- 输入您的代码加工处理要求。
+
+::: warning 警告
+
+该功能需要 AI 模型支持 `function_call` 功能
+
+:::
+
+
+
+::: tip 提示
+
+1. 对于长文件代码可能会面临输出中断问题,目前没有好的解决方法。
+2. 请认真审查处理后的文件,确保无误后再替换源文件。永远不要相信 AI 处理的代码是无误的。
+
+:::
+
+**相关配置:**
+
+- 你可以通过修改 [`aide.apiConcurrency`](../configuration/api-concurrency.md) 配置来自定义 AI 请求并发数。
diff --git a/website/zh/guide/features/copy-as-prompt.md b/website/zh/guide/features/copy-as-prompt.md
index 594daa6..4245f87 100644
--- a/website/zh/guide/features/copy-as-prompt.md
+++ b/website/zh/guide/features/copy-as-prompt.md
@@ -6,7 +6,7 @@
**使用方法:**
-- 在资源管理器中选择文件或文件夹。
+- 在资源管理器中选择文件或文件夹。(多选方法:按住 `Ctrl` 或 `Cmd` 并点击文件或文件夹)
- 右键选择 `✨ Aide: 复制为 AI 提示词`。
diff --git a/website/zh/guide/getting-started/index.md b/website/zh/guide/getting-started/index.md
index ff49b40..79d1a1a 100644
--- a/website/zh/guide/getting-started/index.md
+++ b/website/zh/guide/getting-started/index.md
@@ -5,41 +5,47 @@
## 为什么选择 `Aide`?
-- **😩 你是否在阅读前任留下的混乱代码时痛苦不堪?**
+`Aide` 是一个强大的 AI 辅助开发 `VSCode` 扩展,旨在提升您的编码体验。以下是您应该选择 `Aide` 的原因:
- ✅ `Aide` 可以一键为你添加详细注释,输出到临时文件给你看,提升代码可读性。
+- **📚 提高代码可读性**:一键为您的代码添加详细注释,提高可读性,而无需修改原始文件。
-- **🆕 你在学习新语言或阅读不熟悉的语言项目时,是否希望能用熟悉的语言来理解新代码?**
+- **🔄 轻松代码转换**:即时将代码在不同语言或框架之间转换,使理解不熟悉的代码或迁移项目变得更容易。
- ✅ `Aide` 可以一键将代码转换为你熟悉的语言,输出到临时文件上给你看,让你立马理解其中的逻辑。
+- **🔮 神奇的智能粘贴**:粘贴时智能转换剪贴板内容,包括将设计截图转换为 UI 代码。简化跨语言、跨框架开发和设计到代码的工作流程。
-- **📋 你是否每次都要手动复制多个文件代码粘贴到浏览器里的 AI 网站提问?**
+- **📋 高效批量处理**:轻松使用 AI 处理多个文件或文件夹,显著提高您的生产力。
- ✅ `Aide` 可以批量一键复制多个文件或文件夹里的代码。大大节省你的时间。
+- **🏷️ 智能变量重命名**:获取 AI 驱动的变量名建议及解释,帮助您为代码选择最佳名称。
-- **🤔 你是否总是对自己的变量名不满意?**
+- **🤖 可自定义AI命令**:创建并执行自定义 AI 命令,实现与代码库的灵活交互。
- ✅ `Aide` 可以使用 AI 提供变量名建议和解释,让你选择最佳实践的变量名字。让你的代码更加规范。
+## 主要特性
-- **🔄 你是否经常需要将某种格式的代码转换成另一种格式,再粘贴到项目中?**
+1. **[智能代码查看器助手](../features/code-viewer-helper.md)**:添加 AI 生成的注释,使您的代码更易理解。
- ✅ `Aide` 可以智能识别剪贴板里的代码并猜测你的意图进行智能粘贴。例如,你复制了一个 `JSON` 粘贴到 `TypeScript` 文件里,它会自动转换成 `TypeScript` 类型。或者你复制了 `Tailwind CSS` 代码粘贴到 `Flutter Dart` 文件里,它会自动转换成 `Flutter Widget`。大大节省你的时间。
+2. **[智能代码转换](../features/code-convert.md)**:在 AI 的协助下,将代码从一种编程语言转换为另一种。
-- **⌨️ 你是否在使用类似 [`aider`](https://github.com/paul-gauthier/aider) 的命令行工具时,不希望一个个输入文件路径?**
+3. **[智能粘贴](../features/smart-paste.md)**:粘贴到不同文件类型时,智能转换剪贴板内容。
- ✅ `Aide` 允许你自定义 AI 命令执行的模板,将选中的文件路径传递给 AI 命令。大大节省你的时间。
+4. **[AI批量处理](../features/batch-processor.md)**:根据您的特定需求,使用 AI 处理多个文件。
+
+5. **[批量复制文件为 AI 提示词](../features/copy-as-prompt.md)**:一键将多个文件格式化为 AI 交互提示。
+
+6. **[智能重命名变量](../features/rename-variable.md)**:获取AI对变量名的建议,以提高代码清晰度。
+
+7. **[自定义命令提问 AI](../features/ask-ai.md)**:在选定的文件或文件夹上执行自定义 AI 命令。
## `Aide` 与 `Copilot/Codeium/AmazonQ` 的区别
-- **🚫 不做已有的功能**:我们不会创建一个侧边栏来进行 AI 聊天,也不会提供 AI 自动补全功能,因为这些功能它们已经提供。我们只会做那些我们能做得更好的功能。`Aide` 是它们的补充,而不是替代品。
+- **🚫 无冗余功能**:我们专注于独特的、互补的功能,而不是复制现有工具。
-- **⚡ 只做高效实用的功能**:`Aide` 专注于提供更高效的 AI 功能和更实用的交互方式。每个功能都经过作者深入的思考和设计,确保使用体验良好。
+- **⚡ 注重效率**:每个功能都经过精心设计,以实现最佳用户体验和实际效用。
-- **❌ 不做效果差的功能**:`Aide` 不会提供效果差的功能,例如将整个项目嵌入到 AI 中并向其提问。这样的功能效果通常很差,所以我们不会提供。
+- **💪 质量优先**:我们优先考虑效果好的功能,避免那些在实际使用中效果不佳的功能。
-- **🔓 开源**:`Aide` 是开源的,你可以自由查看源代码。
+- **🔓 开源**:您可以自由查看和贡献我们的源代码。
-- **🛠️ 自定义**:`Aide` 允许你自定义 AI 模型,甚至可以使用本地模型。
+- **🛠️ 可定制**:使用您偏好的 AI 模型,包括本地模型。
## 快速导航
diff --git a/website/zh/guide/use-another-llm/ollama.md b/website/zh/guide/use-another-llm/ollama.md
index 8284f16..098bfdc 100644
--- a/website/zh/guide/use-another-llm/ollama.md
+++ b/website/zh/guide/use-another-llm/ollama.md
@@ -20,7 +20,7 @@
### 模型配置
-你需要配置 [`aide.openaiModel`](../configuration/openai-model.md) 为 `Ollama` 模型,我们推荐使用 `gemma2` 模型。更多模型请参考 [支持的模型列表](https://ollama.com/library)。
+你需要配置 [`aide.openaiModel`](../configuration/openai-model.md) 为 `Ollama` 模型,我们推荐使用 `llama3.1` 模型。更多模型请参考 [支持的模型列表](https://ollama.com/library)。
### 示例配置文件
@@ -30,7 +30,7 @@
{
"aide.openaiBaseUrl": "http://localhost:11434/v1",
"aide.openaiKey": "sk-ollama",
- "aide.openaiModel": "gemma2"
+ "aide.openaiModel": "llama3.1"
}
```
diff --git a/website/zh/index.md b/website/zh/index.md
index ec16d5b..e04f1fb 100644
--- a/website/zh/index.md
+++ b/website/zh/index.md
@@ -2,13 +2,13 @@
layout: home
title: Aide
-titleTemplate: 在 VSCode 里掌握任何屎山代码
+titleTemplate: 在 VSCode 中征服任何代码
hero:
name: Aide
image: /logo.svg
- text: '在 VSCode 里掌握任何屎山代码 💪'
- tagline: '一键注释和语言转换。'
+ text: '在 VSCode 中征服任何代码 💪'
+ tagline: '一键注释、转换、UI 图生成代码、AI 批量处理!'
actions:
- theme: brand
text: 快速开始