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 71
  • Win 35
  • Mac 24
  • Linux 12
Sep 28 Sep 27 Sep 26 Sep 25 Sep 24 Sep 23 Sep 22 Sep 21 Sep 20 Sep 19 Sep 18 Sep 17 Sep 16 Sep 15 Sep 14 Sep 13 Sep 12 Sep 11 Sep 10 Sep 9 Sep 8 Sep 7 Sep 6 Sep 5 Sep 4 Sep 3 Sep 2 Sep 1 Aug 31 Aug 30 Aug 29 Aug 28 Aug 27 Aug 26 Aug 25 Aug 24 Aug 23 Aug 22 Aug 21 Aug 20 Aug 19 Aug 18 Aug 17 Aug 16 Aug 15 Aug 14
Windows 0 0 0 0 1 0 0 2 3 0 0 0 0 0 0 1 1 0 1 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 2 0 2 0 0 2 2 1 0 2 4
Mac 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 1 1 0 0 1 0 1 0 0 0 0 0 1 0 0 1 0 2 0 1 1 0 2 1 0 1 0 0 0 1
Linux 0 1 0 0 0 1 0 0 0 0 0 0 0 0 0 0 3 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 1 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!