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

externalSymbolLinkMappings wildcard #2101

Closed
mistic100 opened this issue Nov 12, 2022 · 1 comment
Closed

externalSymbolLinkMappings wildcard #2101

mistic100 opened this issue Nov 12, 2022 · 1 comment
Labels
enhancement Improved functionality good first issue Easier issue for first time contributors help wanted Contributions are especially encouraged

Comments

@mistic100
Copy link
Contributor

Search Terms

externalSymbolLinkMappings wildcard

Problem

I have a library that heavily relies on three.js package. I import and expose ~20 different objects from three. It is not really important for me that the links for these types are accurate but at least I would like to point the three.js documentation index.

Suggested Solution

Allow externalSymbolLinkMappings to declare wildcard mapping, that would be used if no other mapping match.

    "externalSymbolLinkMappings": {
      "@types/three": {
        "*": "https://threejs.org/docs/"
      },
      "three": {
        "*": "https://threejs.org/docs/"
      }
    }

It would also cover cases when an external library is a single long page.

@mistic100 mistic100 added the enhancement Improved functionality label Nov 12, 2022
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Nov 12, 2022

Seems like a reasonable request 👍

@Gerrit0 Gerrit0 added good first issue Easier issue for first time contributors help wanted Contributions are especially encouraged labels Nov 12, 2022
Gerrit0 added a commit that referenced this issue Nov 13, 2022
Fix #2101 support externalSymbolLinkMappings wildcard
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improved functionality 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