MarkyAI markdownGenerator

MarkyAI - مولد تخفيض السعر (VS Code Extension)

لقد قمت بتوسيع وكيل Pipet-code لإنشاء مساعد كود AI مع إضافة ميزة/أمر جديد لإنشاء مستندات GitHub README جيدة التنسيق في Markdown استنادًا إلى مقتطفات التعليمات البرمجية المحددة. يعد Pipet Code Agent امتدادًا لـ Visual Studio Code تم تطويره بواسطة Google ويستفيد من قوة Google Gemini API لمساعدة المطورين من خلال إنشاء تعليقات ومراجعات للتعليمات البرمجية المحددة.

سمات

• تعليقات مراجعة التعليمات البرمجية : قم تلقائيًا بإنشاء تعليقات مراجعة التعليمات البرمجية التي تحدد الأخطاء وتقترح التحسينات.
• تعليقات الكود : أضف تعليقات توضيحية إلى الكود الخاص بك.
• مولد Markdown README : قم بإنشاء مستندات GitHub README الشاملة بتنسيق Markdown بناءً على الكود المحدد.

أمر جديد: Markdown README Generator

يتيح لك الأمر الجديد المضاف إلى هذا الامتداد إنشاء مستند GitHub README جيد التنظيم في Markdown بناءً على الكود المحدد في المحرر. يتضمن README الرؤوس والأوصاف وأمثلة التعليمات البرمجية المناسبة وتنسيقات Markdown الأخرى ذات الصلة.

مثال الاستخدام

1. قم بتثبيت ملحق عامل رمز Pipet

   نظرًا لعدم نشر الامتداد بعد في VS Code Marketplace، يمكنك اختباره محليًا باتباع الخطوات التالية:

   • استنساخ أو تنزيل هذا المستودع.
   • انتقل إلى دليل المشروع في المحطة الطرفية الخاصة بك.

2. تثبيت التبعيات

   قم بتثبيت تبعيات Node.js المطلوبة باستخدام npm.

   npm install

3. قم بتشغيل الملحق في وضع التصحيح

   افتح المشروع في Visual Studio Code وابدأ في تصحيح الأخطاء لتشغيل الامتداد في نافذة Extension Development Host.

   npm run vscode:prepublish

4. تكوين مفتاح API

   قم بإعداد مفتاح Google Gemini API الخاص بك في إعدادات VS Code.

    // 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. تم إنشاء مثال README

   فيما يلي مثال لملف README الذي تم إنشاؤه استنادًا إلى مقتطف التعليمات البرمجية المحدد:

    # 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.

---