Typedoc: All documentation has "_" as a prefix: This prevents typedocs from being served in gh-pages.

Created on 5 Oct 2015  路  6Comments  路  Source: TypeStrong/typedoc

After removing the "_" in front of all my documentation files, gh-pages worked.

question

Most helpful comment

Just to add this here for history: It's also possible to use Jekyll alongside generated code documentation.

I use a _config.yml with

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

to get the generated files into GitHub Pages.


See here for an example.

All 6 comments

I've noted that too, but this a specific behaviour of GitHub pages and can be easily fixed by including a .nojekyll file at the document root. Documentation on this can be found here.

The underscores are created by the url builder when hitting external modules. There are issues describing better solutions and it should be gone in v0.4.

Just to add this here for history: It's also possible to use Jekyll alongside generated code documentation.

I use a _config.yml with

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

to get the generated files into GitHub Pages.


See here for an example.

@vsund How long after adding that did you see it working? :(

@cope Shouldn't be too long. Within a half hour.

@vsund tnx, it turned out it was still my mistake, I had two _config.yml files and I was editing the wrong one... once I fixed the right one it was available immediately

This is still not fixed - and it seems it worked in the past but doesn't anymore.

Was this page helpful?
0 / 5 - 0 ratings