Tôi đã có vấn đề chính xác với typedocs. README.md hoạt động nhưng không có tài liệu thực tế nào được tạo bởi chuỗi tài liệu của tôi được hiển thị, tôi chỉ có màn hình 404 Github Pages.
Để khắc phục điều này, chỉ cần đặt một tệp trống trong thư mục / docs của bạn (hoặc bất cứ nơi nào bạn tạo tài liệu của mình) và gọi nó .nojekyll
Để xác nhận, cấu trúc tệp của bạn bây giờ sẽ trông như sau:
./docs/.nojekyll # plus all your generated docs
Đẩy cái này lên repo Github từ xa của bạn và các liên kết của bạn sẽ hoạt động ngay bây giờ.
Đồng thời đảm bảo rằng bạn đã chọn trong cài đặt Github của mình:
Settings -> Github Pages -> Source -> master brach /docs folder
Tùy thuộc vào khung tài liệu của bạn, bạn có thể phải tạo lại tệp này mỗi lần cập nhật tài liệu của mình, đây là một ví dụ về việc sử dụng typedocs & tạo tệp .nojekyll mỗi lần trong tệp pack.json:
# package.json
"scripts": {
"typedoc": "typedoc --out docs src && touch docs/.nojekyll"
},