MarkyAI markdownGenerator

MarkyAI - เครื่องมือสร้าง Markdown (ส่วนขยายรหัส VS)

ฉันได้ขยาย Pipet-code-agent เพื่อสร้างผู้ช่วยโค้ด AI ด้วยการเพิ่มคุณสมบัติ/คำสั่งใหม่สำหรับการสร้างเอกสาร GitHub README ที่มีการจัดรูปแบบอย่างดีใน Markdown โดยอิงตามข้อมูลโค้ดที่เลือก Pipet Code Agent เป็นส่วนขยายโค้ด Visual Studio ที่พัฒนาโดย Google ซึ่งใช้ประโยชน์จากประสิทธิภาพของ Google Gemini API เพื่อช่วยเหลือนักพัฒนาโดยการสร้างความคิดเห็นและบทวิจารณ์สำหรับโค้ดที่เลือก

คุณสมบัติ

• ความคิดเห็นเกี่ยวกับการตรวจสอบโค้ด : สร้างความคิดเห็นเกี่ยวกับการตรวจสอบโค้ดโดยอัตโนมัติ ซึ่งระบุจุดบกพร่องและแนะนำการปรับปรุง
• ความคิดเห็นเกี่ยวกับโค้ด : เพิ่มความคิดเห็นที่อธิบายให้กับโค้ดของคุณ
• เครื่องมือสร้าง Markdown README : สร้างเอกสาร GitHub README ที่ครอบคลุมในรูปแบบ Markdown ตามรหัสที่เลือก

คำสั่งใหม่: ตัวสร้าง Markdown README

คำสั่งใหม่ที่เพิ่มลงในส่วนขยายนี้ช่วยให้คุณสร้างเอกสาร GitHub README ที่มีโครงสร้างดีใน Markdown ตามโค้ดที่เลือกในตัวแก้ไข README มีส่วนหัว คำอธิบาย ตัวอย่างโค้ด และการจัดรูปแบบ Markdown อื่นๆ ที่เกี่ยวข้อง

ตัวอย่างการใช้งาน

1. ติดตั้งส่วนขยาย Pipet Code Agent

   เนื่องจากส่วนขยายยังไม่ได้เผยแพร่บน 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

---