Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

How to set public path? #1087

Closed
1 task done
RohitRox opened this issue Aug 7, 2019 · 5 comments
Closed
1 task done

How to set public path? #1087

RohitRox opened this issue Aug 7, 2019 · 5 comments
Labels
duplicate This duplicates another issue question Question about functionality

Comments

@RohitRox
Copy link

RohitRox commented Aug 7, 2019

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.

@RohitRox RohitRox added the bug Functionality does not match expectation label Aug 7, 2019
@aciccarello aciccarello added question Question about functionality and removed bug Functionality does not match expectation labels Aug 7, 2019
@aciccarello
Copy link
Collaborator

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

@RohitRox
Copy link
Author

RohitRox commented Aug 7, 2019

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.

@aciccarello
Copy link
Collaborator

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.

@RohitRox
Copy link
Author

RohitRox commented Aug 7, 2019

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.

@aciccarello
Copy link
Collaborator

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.

@aciccarello aciccarello added the duplicate This duplicates another issue label Aug 7, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
duplicate This duplicates another issue question Question about functionality
Projects
None yet
Development

No branches or pull requests

2 participants