Merge pull request #47 from nicepkg/dev

feat: add doc website
nicepkg · Jul 19, 2024 · 84a67d1 · 84a67d1
2 parents 289d502 + de83aba
commit 84a67d1
Show file tree

Hide file tree

Showing 127 changed files with 5,774 additions and 504 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -14,3 +14,4 @@ deployspec.yml
 .storybook/*.html
 cz-adapter.cjs
 LICENSE
+*.vue
diff --git a/.gitignore b/.gitignore
@@ -12,3 +12,6 @@ node_modules
 temp
 .aider*
 .vscode-test-web
+**/.vitepress/cache
+**/.vitepress/.temp
+.gpt-runner
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -47,22 +47,31 @@
     "titleBar.activeForeground": "#F8FCFD"
   },
   "cSpell.words": [
+    "autoplay",
+    "Codegee",
+    "Codeium",
     "commitlint",
+    "deepseek",
     "esno",
     "execa",
     "fullpath",
     "ianvs",
+    "iconify",
     "knip",
     "langchain",
     "Nicepkg",
     "nodir",
+    "Ollama",
     "openai",
+    "Pipfile",
+    "pyproject",
+    "qwen",
+    "tailwindcss",
     "treeshake",
     "tsup",
     "undici",
-    "vsix"
-  ],
-  "aide.convertLanguagePairs": {
-    "typescript": "python"
-  }
+    "vitepress",
+    "vsix",
+    "Zhipu"
+  ]
 }
diff --git a/.vscodeignore b/.vscodeignore
@@ -13,3 +13,4 @@ scripts
 .vscode-test/**
 .vscode-test-web/**
 out/**
+website/**
diff --git a/README.md b/README.md
@@ -4,9 +4,9 @@
 
 English / [简体中文 🌏](https://github.com/nicepkg/aide/tree/master/README_CN.md)
 
-Master Any Code: One-Click Comments and Language Conversion. 💪
+Mastering Any Code In VSCode: One-click commenting and language conversion. 💪
 
-掌握任何屎山代码：一键注释和语言转换。💪
+在 VSCode 里掌握任何屎山代码：一键注释和语言转换。💪
 
 [![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)
@@ -16,11 +16,18 @@ Master Any Code: One-Click Comments and Language Conversion. 💪
 
 </div>
 
+## Document 📚
+
+- See: [https://aide.nicepkg.cn](https://aide.nicepkg.cn)
+- Video:
+
+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**: Copy files/folders as AI prompts instantly.
+- 📋 **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.
@@ -35,76 +42,13 @@ Master Any Code: One-Click Comments and Language Conversion. 💪
 3. Search for "[Aide](https://marketplace.visualstudio.com/items?itemName=nicepkg.aide-pro)"
 4. Click Install
 
-## Configuration 🛠
-
-See: [Document](https://github.com/nicepkg/aide/tree/master/docs/configuration/README.md)
-
-## Usage 🚀
-
-### 1. Aide: Code Convert
-
-Convert selected code from one programming language to another using AI.
-
-**How to Use:**
-
-- Select code in the editor.
-- Click the paper-like icon in the top right corner or right-click and choose `✨ Aide: Code Convert`.
-
-### 2. Aide: Code Viewer Helper
-
-Add comments to the selected code to make it readable for beginners, using AI.
-
-**How to Use:**
-
-- Select code in the editor.
-- Click the book-like icon in the top right corner or right-click and choose `✨ Aide: Code Viewer Helper`.
-
-### 3. Aide: Copy As AI Prompt
-
-Copy selected files' contents into the clipboard, formatted as a prompt for AI interaction.
-
-**How to Use:**
-
-- Select files or folders in the Explorer.
-- Right-click and choose `✨ Aide: Copy As AI Prompt`.
-
-### 4. Aide: Ask AI
-
-Prepare and execute custom AI commands based on selected files and user input.
-
-**How to Use:**
-
-- Select files or folders in the Explorer.
-- Right-click and choose `✨ Aide: Ask AI`.
-- Enter your question when prompted.
-
-### 5. Aide: Rename Variable
-
-Rename variables using AI-suggested variable names.
-
-**How to Use:**
-
-- Select a variable in the editor.
-- Right-click and choose `✨ Aide: Rename Variable`.
-- Select a suggested variable name.
-
-### 6. Customizing Keyboard Shortcuts
-
-Assign custom keyboard shortcuts to these commands for faster access:
-
-1. Open the Keyboard Shortcuts editor (`Ctrl+K Ctrl+S` or `Cmd+K Cmd+S`).
-2. Search for the desired Aide command.
-3. Click the plus icon next to the command and press your desired key combination.
-
-Enhance your productivity with Aide's AI-powered features. Install now and experience a smarter way to code!
-
 ## ChangeLog 📅
 
 See the [CHANGELOG](https://github.com/nicepkg/aide/blob/master/CHANGELOG.md) for the latest updates.
 
 ## Contributing 🤝
 
-Contributions are welcome! Please feel free to submit a Pull Request. See the [contributing guide](https://github.com/nicepkg/aide/blob/master/CONTRIBUTING.md) for more details.
+Contributions are welcome! Please feel free to submit a Pull Request. See the [Contributing Guide](https://github.com/nicepkg/aide/blob/master/CONTRIBUTING.md) for more details.
 
 This project exists thanks to all the people who contribute:
 

diff --git a/README_CN.md b/README_CN.md
@@ -4,7 +4,7 @@
 
 [English 🌏](https://github.com/nicepkg/aide/tree/master/README.md) / 简体中文
 
-掌握任何屎山代码：一键注释和语言转换。💪
+在 VSCode 里掌握任何屎山代码：一键注释和语言转换。💪
 
 [![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)
@@ -14,15 +14,22 @@
 
 </div>
 
+## 文档 📚
+
+- 查看：[https://aide.nicepkg.cn](https://aide.nicepkg.cn)
+- 视频：
+
+https://github.com/user-attachments/assets/55f85f8e-7515-4da3-b850-9c078b3440d5
+
 ## 功能 ✨
 
 - 🔄 **代码转换**：一键代码语言转换。
 - 📖 **代码注释**：一键添加详细注释，提升可读性。
-- 📋 **快速复制**：即时复制文件/文件夹为AI提示。
-- 💬 **自定义命令**：对选定文件执行自定义AI命令。
-- 🔀 **变量重命名**：使用AI给出的变量名建议重命名变量。
-- 🎛 **提示模板**：定义灵活的AI提示模板。
-- 📁 **多文件支持**：选择多个文件/文件夹进行AI提示或命令。
+- 📋 **快速复制**：批量复制文件/文件夹为 AI 提示。
+- 💬 **自定义命令**：对选定文件执行自定义 AI 命令。
+- 🔀 **变量重命名**：使用 AI 给出的变量名建议重命名变量。
+- 🎛 **提示模板**：定义灵活的 AI 提示模板。
+- 📁 **多文件支持**：选择多个文件/文件夹进行 AI 提示或命令。
 - 🚫 **忽略模式**：使用自定义 glob 规则排除文件/文件夹。
 - ⌨ **快捷键**：设置你偏好的功能快捷键。
 
@@ -33,69 +40,6 @@
 3. 搜索 “[Aide](https://marketplace.visualstudio.com/items?itemName=nicepkg.aide-pro)”
 4. 点击安装
 
-## 配置 🛠
-
-查看：[文档](https://github.com/nicepkg/aide/tree/master/docs/configuration/README_CN.md)
-
-## 用法 🚀
-
-### 1. Aide: 代码转换
-
-使用 AI 将选定的代码从一种编程语言转换为另一种。
-
-**使用方法：**
-
-- 在编辑器中选择代码。
-- 点击右上角的纸张图标或右键选择 `✨ Aide: 代码转换`。
-
-### 2. Aide: 代码查看器助手
-
-使用 AI 为选定的代码添加注释，使其易于初学者阅读。
-
-**使用方法：**
-
-- 在编辑器中选择代码。
-- 点击右上角的书本图标或右键选择 `✨ Aide: 代码查看器助手`。
-
-### 3. Aide: 复制为 AI Prompt
-
-将选定文件的内容复制到剪贴板，并格式化为 AI 交互提示。
-
-**使用方法：**
-
-- 在资源管理器中选择文件或文件夹。
-- 右键选择 `✨ Aide: 复制为 AI Prompt`。
-
-### 4. Aide: 问 AI
-
-基于选定的文件和用户输入准备并执行自定义 AI 命令。
-
-**使用方法：**
-
-- 在资源管理器中选择文件或文件夹。
-- 右键选择 `✨ Aide: 问 AI`。
-- 按提示输入您的问题。
-
-### 5. Aide: 重命名变量
-
-使用 AI 给出几个可能的变量名建议以及解释，帮助您更快地重命名变量。
-
-**使用方法：**
-
-- 在编辑器中选择变量。
-- 点击右键选择 `✨ Aide: 重命名变量`。
-- 选择一个建议的变量名。
-
-### 6. 自定义键盘快捷键
-
-为这些命令分配自定义键盘快捷键以更快地访问：
-
-1. 打开键盘快捷键编辑器（`Ctrl+K Ctrl+S` 或 `Cmd+K Cmd+S`）。
-2. 搜索所需的 Aide 命令。
-3. 点击命令旁的加号图标并按下您想要的快捷键组合。
-
-通过 Aide 的 AI 驱动功能提升您的工作效率。立即安装，体验更智能的编码方式！
-
 ## 更新日志 📅
 
 查看最新的更新和功能：[更新日志](https://github.com/nicepkg/aide/blob/master/CHANGELOG.md)

diff --git a/docs/configuration/README.md b/docs/configuration/README.md
@@ -1,3 +1,9 @@
+# Warm Reminder
+
+## This document is no longer maintained. Please visit [https://aide.nicepkg.cn](https://aide.nicepkg.cn) for the complete documentation.
+
+---
+
 ## Aide Configuration Documentation
 
 To customize Aide's settings and tailor it to your workflow, follow these steps to access its configuration area:

diff --git a/docs/configuration/README_CN.md b/docs/configuration/README_CN.md
@@ -1,3 +1,9 @@
+# 温情提示
+
+## 本处文档不再维护，请移步到 [https://aide.nicepkg.cn](https://aide.nicepkg.cn) 查看完整文档。
+
+---
+
 ## Aide 配置文档
 
 要自定义 Aide 的设置并根据你的工作流程进行调整，请按照以下步骤访问其配置区域：
-Original file line number
+Diff line change
@@ Expand Up / @@ -14,3 +14,4 @@ deployspec.yml @@
     .storybook/*.html
     cz-adapter.cjs
     LICENSE
+    *.vue