Khắc phục sự cố Github Pages
Hướng dẫn này sẽ giúp bạn khắc phục những lý do phổ biến khiến bạn gặp lỗi 404.
Ai có thể sử dụng tính năng này?
GitHub Pages có sẵn trong các kho lưu trữ công cộng với GitHub Free và GitHub Free dành cho tổ chức, và trong các kho lưu trữ công cộng và riêng tư với GitHub Pro, GitHub Team, GitHub Enterprise Cloud và GitHub Enterprise Server. Để biết thêm thông tin, hãy xem " Kế hoạch của GitHub ".
GitHub Pages hiện sử dụng GitHub Actions để thực thi bản dựng Jekyll. Khi sử dụng nhánh làm nguồn bản dựng của bạn, GitHub Actions phải được bật trong kho lưu trữ của bạn nếu bạn muốn sử dụng quy trình làm việc Jekyll tích hợp. Ngoài ra, nếu GitHub Actions không khả dụng hoặc bị tắt, việc thêm tệp .nojekyllvào gốc nhánh nguồn của bạn sẽ bỏ qua quy trình dựng Jekyll và triển khai nội dung trực tiếp. Để biết thêm thông tin về cách bật GitHub Actions, hãy xem " Quản lý cài đặt GitHub Actions cho kho lưu trữ ".
Xử lý lỗi 404
Trong hướng dẫn này, bạn sẽ tìm thấy những lý do phổ biến khiến bạn gặp lỗi 404 khi xây dựng trang GitHub Pages.
- Trang trạng thái của GitHub
- Thiết lập DNS
- Bộ nhớ đệm của trình duyệt
index.htmltài liệu- Nội dung thư mục
- Tên miền tùy chỉnh
- Kho lưu trữ
Trang trạng thái của GitHub
Nếu bạn thấy lỗi 404 khi xây dựng trang GitHub Pages, trước tiên hãy kiểm tra trang Trạng thái của GitHub để biết bất kỳ sự cố nào đang diễn ra.
Thiết lập DNS
Đảm bảo rằng bản ghi DNS của GitHub được thiết lập đúng với nhà cung cấp DNS của bạn. Để biết thêm thông tin, hãy xem " Quản lý tên miền tùy chỉnh cho trang GitHub Pages của bạn ".
Bộ nhớ đệm của trình duyệt
Nếu trang GitHub Pages của bạn là riêng tư và bạn thấy lỗi 404, bạn có thể cần xóa bộ nhớ đệm của trình duyệt. Để biết thêm thông tin về cách xóa bộ nhớ đệm, hãy xem tài liệu của trình duyệt.
index.htmltài liệu
GitHub Pages sẽ tìm kiếm index.htmltệp làm tệp nhập cho trang web của bạn.
-
Đảm bảo bạn có
index.htmltệp trong kho lưu trữ cho trang web của mình trên GitHub. Để biết thêm thông tin, hãy xem " Tạo trang web GitHub Pages ". -
Tệp nhập phải nằm ở cấp cao nhất của nguồn xuất bản bạn chọn. Ví dụ, nếu nguồn xuất bản của bạn là thư
/docsmục trênmainnhánh, tệp nhập của bạn phải nằm trong/docsthư mục trên nhánh có tên làmain.Nếu nguồn xuất bản của bạn là một nhánh và thư mục, tệp mục nhập phải nằm ở cấp cao nhất của thư mục nguồn trên nhánh nguồn. Ví dụ, nếu nguồn xuất bản của bạn là thư
/docsmục trênmainnhánh, tệp mục nhập của bạn phải nằm trong/docsthư mục trên nhánh có tên làmain.Nếu nguồn xuất bản của bạn là quy trình làm việc GitHub Actions, hiện vật mà bạn triển khai phải bao gồm tệp mục nhập ở cấp cao nhất của hiện vật. Thay vì thêm tệp mục nhập vào kho lưu trữ của bạn, bạn có thể chọn để quy trình làm việc GitHub Actions tạo tệp mục nhập của bạn khi quy trình làm việc chạy.
-
Tên tệp
index.htmlphân biệt chữ hoa chữ thường. Ví dụ,Index.htmlsẽ không hoạt động. -
Tên của tập tin phải là
index.html, không phảiindex.HTMLhoặc bất kỳ biến thể nào khác.
Nội dung thư mục
Kiểm tra xem nội dung thư mục của bạn có nằm trong thư mục gốc không.
Tên miền tùy chỉnh
Nếu bạn đang sử dụng tên miền tùy chỉnh, hãy đảm bảo rằng tên miền đó được thiết lập đúng. Để biết thêm thông tin, hãy xem " Giới thiệu về tên miền tùy chỉnh và GitHub Pages ".
- Bản
CNAMEghi phải luôn trỏ đến<USER>.github.iohoặc<ORGANIZATION>.github.io, không bao gồm tên kho lưu trữ. Để biết thêm thông tin về cách tạo bản ghi chính xác, hãy xem tài liệu của nhà cung cấp DNS của bạn. - Nếu bạn có thể truy cập trang đích của mình nhưng gặp phải liên kết bị hỏng trong suốt quá trình, thì có thể là do bạn chưa có tên miền tùy chỉnh trước đó hoặc đang quay lại từ tên miền tùy chỉnh. Trong những trường hợp như vậy, việc thay đổi đường dẫn định tuyến không khởi tạo quá trình xây dựng lại trang. Giải pháp được khuyến nghị là đảm bảo rằng trang web của bạn tự động xây dựng lại khi thêm hoặc xóa tên miền tùy chỉnh. Điều này có thể liên quan đến việc định cấu hình tác giả cam kết và sửa đổi cài đặt tên miền tùy chỉnh.
Kho lưu trữ
Kiểm tra xem kho lưu trữ của bạn có đáp ứng các yêu cầu sau hay không.
- Nhánh bạn đang sử dụng để xuất bản trang web của mình phải là
mainnhánh mặc định hoặc nhánh không mặc định. - Kho lưu trữ phải có một cam kết được đẩy tới bởi người có quyền quản trị kho lưu trữ, chẳng hạn như chủ sở hữu kho lưu trữ.
- Việc chuyển chế độ hiển thị của kho lưu trữ từ công khai sang riêng tư hoặc ngược lại sẽ thay đổi URL của trang GitHub Pages của bạn, điều này sẽ dẫn đến các liên kết bị hỏng cho đến khi trang web được xây dựng lại.
- Nếu bạn đang sử dụng kho lưu trữ riêng tư cho trang GitHub Pages, vui lòng kiểm tra xem đăng ký GitHub Pro, GitHub Team hoặc GitHub Enterprise Cloud của bạn có còn hiệu lực không. Nếu bạn gia hạn gói, trang GitHub Pages sẽ tự động được triển khai lại. Nếu không, bạn có thể thay đổi chế độ hiển thị của kho lưu trữ thành công khai để tiếp tục sử dụng GitHub Pages miễn phí.
Nếu bạn vẫn nhận được lỗi 404, hãy bắt đầu thảo luận trên Cộng đồng GitHub trong danh mục Trang.