HoverDocs
In-line documentation display in Sublime Text
Details
Installs
- Total 309
- Win 164
- Mac 74
- Linux 71
| Jun 13 | Jun 12 | Jun 11 | Jun 10 | Jun 9 | Jun 8 | Jun 7 | Jun 6 | Jun 5 | Jun 4 | Jun 3 | Jun 2 | Jun 1 | May 31 | May 30 | May 29 | May 28 | May 27 | May 26 | May 25 | May 24 | May 23 | May 22 | May 21 | May 20 | May 19 | May 18 | May 17 | May 16 | May 15 | May 14 | May 13 | May 12 | May 11 | May 10 | May 9 | May 8 | May 7 | May 6 | May 5 | May 4 | May 3 | May 2 | May 1 | Apr 30 | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Windows | 0 | 2 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 |
| Mac | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 |
| Linux | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 1 |
Readme
- Source
- raw.githubusercontent.com
HoverDocs
In-line documentation display in Sublime Text.
Features
- finds definitions and documentation
- displays as a popup (below text) or annotation (to the right side)
- hyperlink to quickly move to the definition, or open it in a transient view
- configure popups to show with hover, double click, or key binding
- toggle how hyperlinks work with ctrl key (Windows only)
Demo
Is this package right for me?
If you haven't heard of the LSP package before then please go look at it! It is a very cool plugin that talks to language servers for your language of choice to get more intelligent information about your code.
That being said, there are certain situations in which this package is more useful. HoverDocs is lightweight, doesn't require the installation of additional language servers, and doesn't require any complex environment setup. If any of these situations sound like they apply to you, then you've come to the right place.
Installation
You can install the package with Package Control or manually.
Install with Package Control
- Press Ctrl+Shift+P (or Cmd+Shift+P on Mac) to open the Command Palette
- Select Package Control: Install Package
- Select HoverDocs
Install Manually
- Click the Preferences > Browse Packages… menu, this should open a folder Packages.
- Download https://github.com/gladclef/HoverDocs and move it to that directory.
- Restart Sublime Text.
Key Bindings
There's some example key bindings available. Go to Preferences > Package Settings > HoverDocs > Key Bindings to set them.
Caveats
I've only tested this package with python code. It should be compatible with any language. If you try it and have any issues, please let me know!