[BUG] : Base option not working when relative

[compodoc]

[BUG] : Base option not working when relative

[vogloblinsky]

Hi,
Compodoc documentation is not planned to be used directly by opening index.html and having file:// urls in the browsers.
For example, Lunr.js index json file is loaded with ajax, and will failed in your context.

The only workaround for you is to set the base for your local folder like this example :

compodoc -p src\tsconfig.json -b file://localhost/Volumes/Data/xxx/compodoc-demo-todomvc-angular2/documentation/

[aecz]

Thanks for the workaround. It works except for links that points to /.
If we change this to /index.html everything works perfectly.
Do you think it can be done ? Would you accept a PR for this ?

The idea behind this is to allow easier integration in Jenkins/Bamboo, Visual Studio Code/Atom...
For example, Istanbul report can easily being added to a build result in a CI server. Compodoc cannot at the moment.

[vogloblinsky]

Yep it can be done.
The test case will be :

• build the compodoc ng2 demo in jenkins and export html pages like another reporter
• open the documentation directly in jenkins interface

[PhilippSoehnlein]

Same problem here. Our CI-server (TeamCity) runs compodoc and publishes the generated folder as artifact which is then later displayed on the web frontend of the CI server in an <iframe> serving an URL like that: /repository/download/$buildTaskName/$buildId:id/$artifactName!/index.html. I can't figure out a value for base that works.

[vogloblinsky]

Fixed in 0.0.39

[lock]

This issue has been automatically locked due to inactivity. Please file a new issue if you are encountering a similar or related problem. Why locking ? Having issues with the most up-to-date context.