Typedoc: How to set public path?

Created on 7 Aug 2019  路  5Comments  路  Source: TypeStrong/typedoc

How can I set the public path for assets and links in the generated doc site?
I cannot seem to find an option for it.

duplicate question

All 5 comments

Hello @RohitRox, can you explain more about what you are attempting to accomplish?

Hi @aciccarello, I want to host the docs generated by typedoc in a specific url path.
Let's say something like myproject.com/pkgs/docs/app-kit, in this scenario, if I put contents of typedoc generated folder to be served at that path, the requests to styles and other pages will break.
I guess I am looking for something like webpack's publicPath that can be configured.

TypeDoc uses relative paths so it shouldn't need to set a public path. You can use [[ReflectionName]] to reference other classes, variables, ect. and the links will be automatically generated. I need to check asset links.

Hmm.. I see the all of the links in templates uses relativeURL, even the the links to assets. I was wondering if we could tweak it somehow to tell it to add desired prefix/path; in my case /pkgs/docs/app-kit or http://myproject.com/pkgs/docs/app-kit, by passing some config key to tell it to prefix or is there a way to extend/override the helper method.

Sorry, that's currently not possible without defining a custom theme. I'm going to mark this as a duplicate of #940 so we can track progress there.

Was this page helpful?
0 / 5 - 0 ratings