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 許可證獲得許可。

---