Thêm ví dụ mã mới
Hướng dẫn đóng góp cho Ví dụ mã
- Các bản đóng góp bắt buộc phải được viết bằng tiếng Anh.
- Tài liệu hóa ví dụ của bạn càng chi tiết càng tốt.
- Đảm bảo mã của bạn hoạt động và đã được kiểm tra kỹ lưỡng.
Chúng tôi có quyền:
- Chỉnh sửa bản đóng góp của bạn sau khi được gửi.
- Xóa bản đóng góp của bạn nếu thấy cần thiết.
Tạo một Ví dụ mã mới
1. Fork repository này
2. Clone fork của bạn và chuyển vào thư mục dự án (cd)
3. Cài đặt VitePress
Bạn có thể tìm thấy các yêu cầu tiên quyết của VitePress trong tài liệu chính thức.
sh
npm add -D vitepress@nextsh
pnpm add -D vitepress@nextsh
yarn add -D vitepress@next vuesh
bun add -D vitepress@next4. Thêm Ví dụ mã của bạn
4.1 Tạo tệp ví dụ
- Tạo một tệp mới trong
/docs/examplesđược đặt tên theo ngôn ngữ lập trình. - Tên tệp phải kết thúc bằng
.md. - Bao gồm ít nhất hai cách khác nhau để thực hiện lệnh gọi API.
4.2 Thêm ví dụ vào thanh bên (sidebar)
- Mở
/docs/.vitepress/config.mts. - Tìm phần "Code Examples" trong thanh bên.
- Thêm tệp mới của bạn vào danh sách.
- Giữ danh sách theo thứ tự bảng chữ cái dựa trên ngôn ngữ lập trình.
5. Khởi chạy Server phát triển
Trước khi tạo pull request, hãy kiểm tra cục bộ xem các thay đổi của bạn có làm hỏng thứ gì không.
sh
npm run devsh
pnpm run devsh
yarn devsh
bun run dev6. Tạo Pull Request
Gửi pull request đến repository gốc.