📄 Tài liệu

Hãy giúp mở rộng tài liệu của GaiaNet, giúp các nhà phát triển mới dễ dàng bắt đầu hơn, đây là cách bạn có thể bắt đầu!

Đóng góp

  1. Phân nhánh kho lưu trữ:

    • Ghé thăm Kho tài liệu GaiaNet trên GitHub

    • Nhấp vào nút "Fork" ở góc trên bên phải

    • Chọn nơi bạn muốn phân nhánh kho lưu trữ (tài khoản cá nhân của bạn hoặc tổ chức)

  2. Sao chép kho lưu trữ đã phân nhánh của bạn:

    git clone https://github.com/YOUR-USERNAME/docs.git cd docs
  3. Tạo một nhánh mới cho những thay đổi của bạn:

    git checkout -b nhánh-tính-năng-của-bạn
  4. Thực hiện thay đổi của bạn đối với tài liệu

  5. Cam kết thay đổi của bạn:

    git add . git commit -m "Mô tả về những thay đổi của bạn"
  6. Đẩy những thay đổi của bạn vào nhánh của bạn:

    git push origin nhánh-tính-năng-của-bạn
  7. Tạo yêu cầu kéo:

    • Đi đến nhánh của bạn trên GitHub

    • Nhấp vào "Yêu cầu kéo" và chọn "Yêu cầu kéo mới"

    • Chọn nhánh tính năng của bạn và gửi yêu cầu kéo Vui lòng đảm bảo rằng những đóng góp của bạn phù hợp với phong cách và tiêu chuẩn tài liệu của chúng tôi.

Chạy Tài liệu cục bộ

Sau khi phân nhánh và sao chép kho lưu trữ:

  1. Cài đặt các phụ thuộc:

    cài đặt npm
  2. Khởi động máy chủ phát triển:

    npm bắt đầu
  3. Mở trình duyệt của bạn và truy cập http://localhost:3000

Kết cấu

  • tài liệu/: Bao gồm tất cả các tệp đánh dấu cho tài liệu

  • nguồn/: Các thành phần và trang React tùy chỉnh

  • tĩnh/: Tài sản tĩnh như hình ảnh

  • docusaurus.config.js: Tệp cấu hình chính cho Docusaurus

Triển khai

Tài liệu này được triển khai tự động tới docs.gaianet.ai khi những thay đổi được hợp nhất vào nhánh chính.

Cần trợ giúp?

Nếu bạn có bất kỳ câu hỏi nào hoặc cần hỗ trợ, vui lòng mở một vấn đề trong kho lưu trữ hoặc liên hệ qua kênh cộng đồng của chúng tôi.

Cập nhật lần cuối

Thông tin này có hữu ích không?