Skip to content

Provide an option to link standard classes to MDN #895

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

Closed
FranklinYu opened this issue Nov 2, 2018 · 1 comment
Closed

Provide an option to link standard classes to MDN #895

FranklinYu opened this issue Nov 2, 2018 · 1 comment
Labels
plugin idea This feature may be best suited for a plugin wontfix Declining to implement

Comments

@FranklinYu
Copy link

FranklinYu commented Nov 2, 2018

For example, if my function returns Promise<string>, I would like TypeDoc to render it as Promise<string>. MDN is almost the official documentation of JavaScript (easier to read than the standard), but user may also want to link to other sources like Node.js. I imagine the API be like

typedoc --link MDN --link nodejs-v10.x ./src/
@FranklinYu FranklinYu changed the title Provide an option to link standard classes to MDN (or other websites) Provide an option to link standard classes to MDN Nov 2, 2018
@aciccarello
Copy link
Collaborator

Thanks for sharing the idea. This likely won't be added to the core project anytime soon. I believe this would be a good use case for a plugin.

@aciccarello aciccarello added wontfix Declining to implement plugin idea This feature may be best suited for a plugin and removed enhancement labels Nov 2, 2018
@Gerrit0 Gerrit0 closed this as completed Nov 13, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
plugin idea This feature may be best suited for a plugin wontfix Declining to implement
Projects
None yet
Development

No branches or pull requests

3 participants