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

Render links tohostedBaseUrl as internal links #2809

Closed
aleksei-berezkin opened this issue Dec 12, 2024 · 1 comment
Closed

Render links tohostedBaseUrl as internal links #2809

aleksei-berezkin opened this issue Dec 12, 2024 · 1 comment
Labels
good first issue Easier issue for first time contributors help wanted Contributions are especially encouraged

Comments

@aleksei-berezkin
Copy link

Search Terms

external internal links hostedBaseUrl

Problem

When generating a link to hostedBaseUrl (that is, to self), TypeDoc generates “external” links, that is, absolute links with target="_blank", and with “external” icon.

Steps to reproduce:

  • Check out test project https://github.com/aleksei-berezkin/typedoc-test-project
  • run npm run typedoc to generate docs
  • run npm run serve
  • Open the link to localhost in the browser
  • Check the “Test link” in README — it's rendered as an external link and opens in the new browser tab
  • Check the “test link” in TestInterface — also rendered external

Suggested Solution

Generate links pointing to hostedBaseUrl as “internal” links, i.e. relative (by default), without “external” icon, without target="_blank".

@aleksei-berezkin aleksei-berezkin added the enhancement Improved functionality label Dec 12, 2024
@Gerrit0 Gerrit0 added help wanted Contributions are especially encouraged good first issue Easier issue for first time contributors labels Dec 14, 2024
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Dec 14, 2024

Seems like a reasonable thing to do, PR welcome!

@Gerrit0 Gerrit0 removed the enhancement Improved functionality label Feb 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Easier issue for first time contributors help wanted Contributions are especially encouraged
Projects
None yet
Development

No branches or pull requests

2 participants