MarkyAI markdownGenerator

MarkyAI - Markdown 生成器（VS 代码扩展）

我扩展了 Pipet-code-agent 来构建 AI 代码助手，并添加了新功能/命令，用于根据选定的代码片段在 Markdown 中生成格式良好的 GitHub README 文档。 Pipet Code Agent 是 Google 开发的 Visual Studio Code 扩展，它利用 Google Gemini API 的强大功能，通过为选定的代码生成评论和评论来帮助开发人员。

特征

• 代码审查评论：自动生成代码审查评论，以识别错误并提出改进建议。
• 代码注释：向您的代码添加解释性注释。
• Markdown README Generator ：根据所选代码生成 Markdown 格式的全面 GitHub README 文档。

新命令：Markdown README 生成器

添加到此扩展的新命令允许您根据编辑器中选择的代码在 Markdown 中生成结构良好的 GitHub README 文档。自述文件包括适当的标题、描述、代码示例和其他相关的 Markdown 格式。

用法示例

1. 安装 Pipet Code Agent 扩展

   由于该扩展尚未在 VS Code Marketplace 上发布，您可以按照以下步骤在本地进行测试：

   • 克隆或下载此存储库。
   • 导航到终端中的项目目录。

2. 安装依赖项

   使用 npm 安装所需的 Node.js 依赖项。

   npm install

3. 在调试模式下运行扩展

   在 Visual Studio Code 中打开项目并开始调试以在扩展开发主机窗口中运行扩展。

   npm run vscode:prepublish

4. 配置API密钥

   在 VS Code 设置中设置您的 Google Gemini API 密钥。

    // settings.json
   {
       "google.gemini.apiKey" : " your-api-key-here "
   }

5. 使用 Markdown README 生成器命令

   • 在编辑器中选择要记录的代码片段。
   • 打开命令选项板（ Ctrl+Shift+P或Cmd+Shift+P ）。
   • 输入Pipet: Create README from Selected Text并选择命令。

6. 生成的自述文件示例

   以下是基于所选代码片段生成的自述文件的示例：

    # API Key Loader
   
   This script attempts to load the API key from the environment.
   
   ## Features
   - Securely load API keys
   - Easy to integrate
   
   ## Example Usage
   
   ``` python
   api_key = os.getenv( " GOOGLE_API_KEY " )

贡献

欢迎对此扩展做出贡献！如果您有改进或新功能的建议，请随时在 Pipet Markdown Agent GitHub 存储库上提出问题或创建拉取请求。

执照

该项目根据 Apache 2.0 许可证获得许可。

---