Skip to content

การเพิ่มตัวอย่างโค้ดใหม่ ​

แนวทางการส่งตัวอย่างโค้ด ​

  • เนื้อหาที่ส่งเข้ามาต้องเขียนเป็นภาษาอังกฤษ
  • เขียนคำอธิบายตัวอย่างโค้ดให้ละเอียดที่สุดเท่าที่จะทำได้
  • ตรวจสอบให้แน่ใจว่าโค้ดทำงานได้จริงและผ่านการทดสอบเรียบร้อยแล้ว

เราขอสงวนสิทธิ์ในการ: ​

  • ปรับแก้ไขเนื้อหาของคุณหลังจากส่งเข้ามาแล้ว
  • ลบเนื้อหาของคุณออกหากจำเป็น

การสร้างตัวอย่างโค้ดใหม่ ​

1. Fork repository นี้ ​

2. Clone fork ของคุณ แล้ว cd เข้าไปยังโฟลเดอร์โปรเจกต์ ​

3. ติดตั้ง VitePress ​

ดูข้อกำหนดเบื้องต้นของ VitePress ได้ที่ เอกสารอย่างเป็นทางการ

sh
npm add -D vitepress@next
sh
pnpm add -D vitepress@next
sh
yarn add -D vitepress@next vue
sh
bun add -D vitepress@next

4. เพิ่มตัวอย่างโค้ดของคุณ ​

4.1 สร้างไฟล์ตัวอย่าง ​

  1. สร้างไฟล์ใหม่ใน /docs/examples โดยตั้งชื่อตามภาษาโปรแกรม
  2. ชื่อไฟล์ต้องลงท้ายด้วย .md
  3. ใส่ตัวอย่างการเรียกใช้งาน API อย่างน้อย 2 วิธีที่แตกต่างกัน

4.2 เพิ่มตัวอย่างลงในแถบด้านข้าง (Sidebar) ​

  1. เปิดไฟล์ /docs/.vitepress/config.mts
  2. ค้นหาส่วน "Code Examples" ใน sidebar
  3. เพิ่มไฟล์ใหม่ของคุณลงในรายการ
  4. จัดเรียงรายการตามลำดับตัวอักษรของชื่อภาษาโปรแกรม

5. รันเซิร์ฟเวอร์สำหรับพัฒนา (Development Server) ​

ก่อนสร้าง pull request ให้ทดสอบในเครื่องก่อนเพื่อให้แน่ใจว่าการแก้ไขไม่ได้ทำให้ส่วนอื่นเสียหาย

sh
npm run dev
sh
pnpm run dev
sh
yarn dev
sh
bun run dev

6. สร้าง Pull Request ​

ส่ง pull request มายัง repository ต้นฉบับ