Eu tive esse problema exato com typedocs. O README.md funcionou, mas nenhum dos documentos reais gerados pelas minhas strings de documentos foi exibido, apenas obtive uma tela 404 Github Pages.
Para corrigir isso, basta colocar um arquivo vazio no diretório / docs (ou onde quer que você o gere) e chame-o .nojekyll
Para confirmar, sua estrutura de arquivos agora deve se parecer com:
./docs/.nojekyll # plus all your generated docs
Envie isso para o seu repositório remoto do Github e seus links etc. devem funcionar agora.
Verifique também se você selecionou nas configurações do Github:
Settings -> Github Pages -> Source -> master brach /docs folder
Dependendo da estrutura do seu documento, você provavelmente precisará recriar esse arquivo sempre que atualizar seus documentos. Este é um exemplo de uso de typedocs e criação do arquivo .nojekyll sempre em um arquivo package.json:
# package.json
"scripts": {
"typedoc": "typedoc --out docs src && touch docs/.nojekyll"
},