MarkyAI markdownGenerator

MarkyAI – Markdown-Generator (VS-Code-Erweiterung)

Ich habe Pipet-code-agent erweitert, um einen KI-Code-Assistenten zu erstellen, indem ich eine neue Funktion/einen neuen Befehl zum Generieren gut formatierter GitHub-README-Dokumente in Markdown basierend auf ausgewählten Codeausschnitten hinzugefügt habe. Der Pipet Code Agent ist eine von Google entwickelte Visual Studio Code-Erweiterung, die die Leistungsfähigkeit der Google Gemini API nutzt, um Entwickler durch die Generierung von Kommentaren und Rezensionen für ausgewählten Code zu unterstützen.

Merkmale

• Kommentare zur Codeüberprüfung : Generieren Sie automatisch Codeüberprüfungskommentare, die Fehler identifizieren und Verbesserungen vorschlagen.
• Codekommentare : Fügen Sie Ihrem Code erklärende Kommentare hinzu.
• Markdown README-Generator : Generieren Sie umfassende GitHub README-Dokumente im Markdown-Format basierend auf ausgewähltem Code.

Neuer Befehl: Markdown README Generator

Der dieser Erweiterung hinzugefügte neue Befehl ermöglicht es Ihnen, ein gut strukturiertes GitHub README-Dokument in Markdown basierend auf dem im Editor ausgewählten Code zu generieren. Die README-Datei enthält entsprechende Header, Beschreibungen, Codebeispiele und andere relevante Markdown-Formatierungen.

Beispielverwendung

1. Installieren Sie die Pipet Code Agent-Erweiterung

   Da die Erweiterung noch nicht auf dem VS Code Marketplace veröffentlicht ist, können Sie sie lokal testen, indem Sie die folgenden Schritte ausführen:

   • Klonen Sie dieses Repository oder laden Sie es herunter.
   • Navigieren Sie zum Projektverzeichnis in Ihrem Terminal.

2. Abhängigkeiten installieren

   Installieren Sie die erforderlichen Node.js-Abhängigkeiten mit npm.

   npm install

3. Führen Sie die Erweiterung im Debug-Modus aus

   Öffnen Sie das Projekt in Visual Studio Code und beginnen Sie mit dem Debuggen, um die Erweiterung in einem Extension Development Host-Fenster auszuführen.

   npm run vscode:prepublish

4. API-Schlüssel konfigurieren

   Richten Sie Ihren Google Gemini-API-Schlüssel in den VS-Code-Einstellungen ein.

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

5. Verwenden Sie den Markdown README Generator-Befehl

   • Wählen Sie in Ihrem Editor den Codeausschnitt aus, den Sie dokumentieren möchten.
   • Öffnen Sie die Befehlspalette ( Ctrl+Shift+P oder Cmd+Shift+P ).
   • Geben Sie Pipet: Create README from Selected Text und wählen Sie den Befehl aus.

6. Generiertes README-Beispiel

   Hier ist ein Beispiel einer generierten README-Datei basierend auf einem ausgewählten Codeausschnitt:

    # 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 " )

Mitwirken

Beiträge zu dieser Erweiterung sind willkommen! Wenn Sie Vorschläge für Verbesserungen oder neue Funktionen haben, können Sie gerne ein Issue öffnen oder eine Pull-Anfrage im Pipet Markdown Agent GitHub-Repository erstellen.

Lizenz

Dieses Projekt ist unter der Apache 2.0-Lizenz lizenziert.

---