Overview Version History Q & A Rating & Review
What's Up Doc
Link code to external documentation 🚀 Whats Up Doc provides a hover tooltip over any configured items, allowing you and your team to view documentation inside VS Code!
https://user-images.githubusercontent.com/24691226/205965066-6f39abe0-1ef0-40fd-a6fa-5149ffdd07d3.mp4
Features
🚁 Hover over items to see the documentation link
👓 View documentation inside VS Code
✨ Store your settings remotely on a public URL
🪟 Custom documentation web view title
🔡 Custom documentation link text
Requirements
The extension requires the following workspace settings to work correctly:
{
"whats-up-doc": {
"elements": {
"@your-package/ui": {
"Button": "https://your-docs.com/button",
"Input": "https://your-docs.com/input"
}
}
}
}
Additional Settings
Property
Type
Description
whats-up-doc.webViewTabTitle
string
The title of the web view tab
whats-up-doc.hoverLinkText
string
The text displayed within the hover box
whats-up-doc.remoteSettingsEndpoint
string
An endpoint who's response is a JSON representation of the extension settings