https://github.com/mutsuntsai/jsdoc-link

Preview JSDoc link in-place.
https://github.com/mutsuntsai/jsdoc-link

jsdoc typescript vscode-extension

Last synced: about 1 month ago
JSON representation

Preview JSDoc link in-place.

• Host: GitHub
• URL: https://github.com/mutsuntsai/jsdoc-link
• Owner: MuTsunTsai
• License: mit
• Created: 2021-06-27T07:01:02.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-03-21T03:47:33.000Z (almost 2 years ago)
• Last Synced: 2023-03-21T11:48:33.053Z (almost 2 years ago)
• Topics: jsdoc, typescript, vscode-extension
• Language: TypeScript
• Homepage: https://marketplace.visualstudio.com/items?itemName=MuTsunTsai.jsdoc-link
• Size: 338 KB
• Stars: 3
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# JSDoc Link

> Preview JSDoc link in-place.

VS Code began to support JSDoc [`@link`](https://jsdoc.app/tags-inline-link.html) syntax

for JavaScript and TypeScript since version 1.57,

which is really cool and helpful,

but at the same time could result in low readability on the doc itself,

especially if alternative text is used:

![](https://github.com/MuTsunTsai/jsdoc-link/raw/main/docs/1.png)

With this extension, all `@link` will be converted to just the link text when the line is not currently selected, and the hovering message is kept as well.

![](https://github.com/MuTsunTsai/jsdoc-link/raw/main/docs/2.png)