Menambahkan Contoh Kode Baru
Panduan Kontribusi untuk Contoh Kode
- Pengajuan harus ditulis dalam bahasa Inggris.
- Dokumentasikan contoh Anda selengkap mungkin.
- Pastikan kode Anda berfungsi dan telah diuji dengan benar.
Kami berhak untuk:
- Mengubah pengajuan Anda setelah dikirimkan.
- Menghapus pengajuan Anda jika diperlukan.
Membuat Contoh Kode Baru
1. Fork repositori ini
2. Kloning fork Anda dan masuk (cd) ke direktori proyek
3. Instal VitePress
Anda dapat menemukan prasyarat VitePress di dokumentasi resmi.
sh
npm add -D vitepress@nextsh
pnpm add -D vitepress@nextsh
yarn add -D vitepress@next vuesh
bun add -D vitepress@next4. Tambahkan Contoh Kode Anda
4.1 Buat berkas contoh
- Buat berkas baru di
/docs/examplesyang dinamai sesuai bahasa pemrograman. - Nama berkas harus diakhiri dengan
.md. - Sertakan setidaknya dua cara berbeda untuk melakukan panggilan API.
4.2 Tambahkan contoh ke bilah sisi (sidebar)
- Buka
/docs/.vitepress/config.mts. - Temukan bagian "Code Examples" di bilah sisi.
- Tambahkan berkas baru Anda ke daftar.
- Jaga agar daftar tetap berurutan secara alfabetis berdasarkan bahasa pemrograman.
5. Jalankan Server Pengembang
Sebelum membuat pull request, verifikasi secara lokal bahwa perubahan Anda tidak merusak apa pun.
sh
npm run devsh
pnpm run devsh
yarn devsh
bun run dev6. Buat Pull Request
Kirimkan pull request ke repositori asli.