ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Hover​Docs

by gladclef ST4

In-line documentation display in Sublime Text

Details

Installs

  • Total 238
  • Win 133
  • Mac 54
  • Linux 51
Mar 4 Mar 3 Mar 2 Mar 1 Feb 29 Feb 28 Feb 27 Feb 26 Feb 25 Feb 24 Feb 23 Feb 22 Feb 21 Feb 20 Feb 19 Feb 18 Feb 17 Feb 16 Feb 15 Feb 14 Feb 13 Feb 12 Feb 11 Feb 10 Feb 9 Feb 8 Feb 7 Feb 6 Feb 5 Feb 4 Feb 3 Feb 2 Feb 1 Jan 31 Jan 30 Jan 29 Jan 28 Jan 27 Jan 26 Jan 25 Jan 24 Jan 23 Jan 22 Jan 21 Jan 20
Windows 0 0 0 0 0 0 0 0 0 0 1 0 1 0 0 0 0 0 0 0 2 3 0 1 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 1 0 0 0 0 0
Mac 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 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 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

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

Demo Gif

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

  1. Press Ctrl+Shift+P (or Cmd+Shift+P on Mac) to open the Command Palette
  2. Select Package Control: Install Package
  3. Select HoverDocs

Install Manually

  1. Click the Preferences > Browse Packages… menu, this should open a folder Packages.
  2. Download https://github.com/gladclef/HoverDocs and move it to that directory.
  3. 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!