MarkyAI markdownGenerator

MarkyAI - Generator Penurunan Harga (Ekstensi Kode VS)

Saya telah memperluas agen kode Pipet untuk membuat asisten kode AI dengan menambahkan fitur/perintah baru untuk menghasilkan dokumen GitHub README yang diformat dengan baik di Markdown berdasarkan cuplikan kode yang dipilih. Agen Kode Pipet adalah ekstensi Visual Studio Code yang dikembangkan oleh Google yang memanfaatkan kekuatan Google Gemini API untuk membantu pengembang dengan menghasilkan komentar dan ulasan untuk kode yang dipilih.

Fitur

• Komentar Tinjauan Kode : Secara otomatis menghasilkan komentar tinjauan kode yang mengidentifikasi bug dan menyarankan perbaikan.
• Komentar Kode : Tambahkan komentar penjelasan ke kode Anda.
• Markdown README Generator : Hasilkan dokumen GitHub README yang komprehensif dalam format Markdown berdasarkan kode yang dipilih.

Perintah Baru: Markdown README Generator

Perintah baru yang ditambahkan ke ekstensi ini memungkinkan Anda membuat dokumen GitHub README yang terstruktur dengan baik di Markdown berdasarkan kode yang dipilih di editor. README mencakup header, deskripsi, contoh kode, dan format penurunan harga relevan lainnya yang sesuai.

Contoh Penggunaan

1. Instal Ekstensi Agen Kode Pipet

   Karena ekstensi belum dipublikasikan di VS Code Marketplace, Anda dapat mengujinya secara lokal dengan mengikuti langkah-langkah berikut:

   • Kloning atau unduh repositori ini.
   • Arahkan ke direktori proyek di terminal Anda.

2. Instal Dependensi

   Instal dependensi Node.js yang diperlukan menggunakan npm.

   npm install

3. Jalankan Ekstensi dalam Mode Debug

   Buka proyek dalam Visual Studio Code dan mulai debugging untuk menjalankan ekstensi di jendela Extension Development Host.

   npm run vscode:prepublish

4. Konfigurasikan Kunci API

   Siapkan kunci API Google Gemini Anda di pengaturan VS Code.

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

5. Gunakan Perintah Generator README Penurunan Harga

   • Pilih cuplikan kode di editor yang ingin Anda dokumentasikan.
   • Buka palet perintah ( Ctrl+Shift+P atau Cmd+Shift+P ).
   • Ketik Pipet: Create README from Selected Text dan pilih perintah.

6. Contoh README yang dihasilkan

   Berikut adalah contoh README yang dihasilkan berdasarkan cuplikan kode yang dipilih:

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

Berkontribusi

Kontribusi pada ekstensi ini dipersilahkan! Jika Anda memiliki saran untuk perbaikan atau fitur baru, silakan buka masalah atau buat permintaan penarikan di repositori GitHub Agen Penurunan Harga Pipet.

Lisensi

Proyek ini dilisensikan di bawah Lisensi Apache 2.0.

---