Simple ElDoc frontend that displays documentation in a floating child frame
Go to file
Yuan Fu 445a56e2fb
Update readme
Suggest how to use with eglot.
2018-12-11 10:33:52 -05:00
eldoc-box.el Rename to eldoc-box 2018-12-11 09:15:00 -05:00
README.org Update readme 2018-12-11 10:33:52 -05:00

This package displays ElDoc documentations in a childframe.

Install

Get the file, add to load path, and

(require 'eldoc-box)

Usage

Show the documentation of the symbol at point: eldoc-box-help-at-point

Show documentation upon hover: eldoc-box-hover-mode. Note that you need to enable ElDoc mode for this to work.

Adjust :background of eldoc-box-border face for border color. Adjust :background of eldoc-box-body face for background color of childframe.

Use with eglot

As of writing this README, eglot doesn't have a public mode hook, use this hook:

(add-hook 'eglot--managed-mode-hook #'eldoc-box-hover-mode t)