Giới thiệu

Guidebook Cloud là dịch vụ hosting tài liệu nội bộ, tương thích với GitBook/HonKit. Với Guidebook Cloud, bạn có thể xuất bản tài liệu từ repository GitHub một cách tự động và an toàn.

Tính năng chính

  • Tự động deploy - Tự động xây dựng và xuất bản tài liệu khi push code lên GitHub
  • Kiểm soát truy cập - Giới hạn truy cập theo địa chỉ IP
  • Quản lý team - Tổ chức thành viên và repository thành các team
  • Tích hợp GitHub - Kết nối trực tiếp với GitHub App
  • Hỗ trợ nhiều branch - Xem trước tài liệu từ các branch khác nhau

Cách hoạt động

  1. Kết nối GitHub - Cài đặt Guidebook Cloud GitHub App vào repository của bạn
  2. Cấu hình - Chọn đường dẫn đến thư mục tài liệu (ví dụ: docs/)
  3. Push - Khi bạn push code, tài liệu sẽ tự động được xây dựng và xuất bản
  4. Truy cập - Tài liệu được xuất bản tại https://guidebook.dev/{org-slug}/{repo-slug}/

Bắt đầu

Sẵn sàng chưa? Hãy xem hướng dẫn Bắt đầu nhanh để tạo tổ chức đầu tiên của bạn.

Yêu cầu

  • Tài khoản GitHub
  • Repository chứa tài liệu theo định dạng GitBook/HonKit (có file SUMMARY.md)