У меня была именно эта проблема с Typedocs. README.md работал, но не отображались никакие документы, сгенерированные моими строками документов, я только что получил экран 404 страниц Github.
Чтобы это исправить, просто поместите пустой файл в каталог / docs (или там, где вы генерируете свои документы) и назовите его .nojekyll
Чтобы подтвердить, ваша файловая структура должна выглядеть так:
./docs/.nojekyll # plus all your generated docs
Отправьте это на удаленный репозиторий Github, и ваши ссылки и т. Д. Теперь должны работать.
Также убедитесь, что вы выбрали в настройках Github:
Settings -> Github Pages -> Source -> master brach /docs folder
В зависимости от вашей структуры документов, вам, вероятно, придется заново создавать этот файл каждый раз, когда вы обновляете свои документы, это пример использования typedocs и создания файла .nojekyll каждый раз в файле package.json:
# package.json
"scripts": {
"typedoc": "typedoc --out docs src && touch docs/.nojekyll"
},