การเพิ่มตัวอย่างโค้ดใหม่
แนวทางการส่งตัวอย่างโค้ด
- เนื้อหาที่ส่งเข้ามาต้องเขียนเป็นภาษาอังกฤษ
- เขียนคำอธิบายตัวอย่างโค้ดให้ละเอียดที่สุดเท่าที่จะทำได้
- ตรวจสอบให้แน่ใจว่าโค้ดทำงานได้จริงและผ่านการทดสอบเรียบร้อยแล้ว
เราขอสงวนสิทธิ์ในการ:
- ปรับแก้ไขเนื้อหาของคุณหลังจากส่งเข้ามาแล้ว
- ลบเนื้อหาของคุณออกหากจำเป็น
การสร้างตัวอย่างโค้ดใหม่
1. Fork repository นี้
2. Clone fork ของคุณ แล้ว cd เข้าไปยังโฟลเดอร์โปรเจกต์
3. ติดตั้ง VitePress
ดูข้อกำหนดเบื้องต้นของ VitePress ได้ที่ เอกสารอย่างเป็นทางการ
sh
npm add -D vitepress@nextsh
pnpm add -D vitepress@nextsh
yarn add -D vitepress@next vuesh
bun add -D vitepress@next4. เพิ่มตัวอย่างโค้ดของคุณ
4.1 สร้างไฟล์ตัวอย่าง
- สร้างไฟล์ใหม่ใน
/docs/examplesโดยตั้งชื่อตามภาษาโปรแกรม - ชื่อไฟล์ต้องลงท้ายด้วย
.md - ใส่ตัวอย่างการเรียกใช้งาน API อย่างน้อย 2 วิธีที่แตกต่างกัน
4.2 เพิ่มตัวอย่างลงในแถบด้านข้าง (Sidebar)
- เปิดไฟล์
/docs/.vitepress/config.mts - ค้นหาส่วน "Code Examples" ใน sidebar
- เพิ่มไฟล์ใหม่ของคุณลงในรายการ
- จัดเรียงรายการตามลำดับตัวอักษรของชื่อภาษาโปรแกรม
5. รันเซิร์ฟเวอร์สำหรับพัฒนา (Development Server)
ก่อนสร้าง pull request ให้ทดสอบในเครื่องก่อนเพื่อให้แน่ใจว่าการแก้ไขไม่ได้ทำให้ส่วนอื่นเสียหาย
sh
npm run devsh
pnpm run devsh
yarn devsh
bun run dev6. สร้าง Pull Request
ส่ง pull request มายัง repository ต้นฉบับ