Tuve este problema exacto con typedocs. El archivo README.md funcionó pero ninguno de los documentos reales generados por mis cadenas de documentos se muestran, acabo de recibir una pantalla de 404 páginas de Github.
Para solucionar esto, simplemente coloque un archivo vacío en su directorio / docs (o donde sea que genere sus documentos) y llámelo .nojekyll
Para confirmar, su estructura de archivos ahora debería verse así:
./docs/.nojekyll # plus all your generated docs
Empuje esto a su repositorio remoto de Github y sus enlaces, etc., deberían funcionar ahora.
También asegúrese de haber seleccionado en su configuración de Github:
Settings -> Github Pages -> Source -> master brach /docs folder
Dependiendo de su marco de documentación, es probable que tenga que volver a crear este archivo cada vez que actualice sus documentos, este es un ejemplo del uso de typedocs y la creación del archivo .nojekyll cada vez en un archivo package.json:
# package.json
"scripts": {
"typedoc": "typedoc --out docs src && touch docs/.nojekyll"
},