Typedoc: Cannot visit multiple pages in GitHub Pages

Created on 12 Oct 2017  路  7Comments  路  Source: TypeStrong/typedoc

I have a little TypeScript project for which I've written and generated the documentation using TypeDoc, but the only page displaying without problems is the index. What can be done in order to fix this?

duplicate question

Most helpful comment

Also adding a config.yml works:

include:
  - "_*_.html"
  - "_*_.*.html"

I found that with my latest trial, .nojekyll doesn't display modules/* pages. However, using the config.yml approach works perfectly.

All 7 comments

This was answered by @sebastian-lenz in #149.

The quick fix is to add a .nojekyll file to the root directory of your generated docs. Full documentation can be found here.

Duplicate of #149

Thanks for pointing that out @phillip-elm

@phillip-elm solution still works

Also adding a config.yml works:

include:
  - "_*_.html"
  - "_*_.*.html"

I found that with my latest trial, .nojekyll doesn't display modules/* pages. However, using the config.yml approach works perfectly.

Added .nojekyll file, but one specific page still won't show up and says 404

Page file can be found here, and here is the link by which it should open.

@yukipastelcat going to the link and clicking on the class name works for me. I'd recommend clearing your cache.

Is there a way to automatically add the .nojekyll file to the documentation build output folder using the typedoc command? It gets deleted every time I rebuild the docs and I have to manually re-add it.

EDIT: Went with the above comment's solution using _config.yml with the included underscore prepended files. Be sure to spell the file name correctly and put it in your root folder (which is where I set my GH pages to live, NOT the docs folder).

Was this page helpful?
0 / 5 - 0 ratings

Related issues

rbuckton picture rbuckton  路  3Comments

ShadowManu picture ShadowManu  路  4Comments

goodmind picture goodmind  路  3Comments

KevinEady picture KevinEady  路  3Comments

cfischer picture cfischer  路  4Comments