Simple ElDoc frontend that displays documentation in a floating child frame

Go to file

Jessie Hildebrandt 7931cbaadb Fix compatibility with Emacs 28.1		2023-12-09 05:49:49 -05:00
.repo-assets	Update preview image	2023-12-08 08:01:29 -05:00
eldoc-frame.el	Fix compatibility with Emacs 28.1	2023-12-09 05:49:49 -05:00
README.md	Decrease icon size in README.md	2023-12-08 07:49:16 -05:00

README.md

eldoc-frame

A simple ElDoc frontend that displays documentation in a floating child frame.

Forked from the excellent eldoc-box package.

Preview

Configuration

If you are a user of use-package, it is easy to configure eldoc-frame directly in your init.el:

(use-package eldoc-frame
  :config
  (eldoc-frame-mode)
  :bind
  (:map eldoc-frame-mode-map
        ("M-<up>" . eldoc-frame-scroll-down-line)
        ("M-<down>" . eldoc-frame-scroll-up-line)))

Alternatives

eldoc-box: eldoc-box implements additional features such as a hover-at-point mode and an interactive help-at-point function.
lsp-ui: Includes lsp-ui-doc, which supports rendering Markdown in child frames and WebKit widgets. Only supports object documentation supplied by lsp-mode.

Feedback

If you experience any issues with this package, please open an issue on the issue tracker.

Suggestions for improvements and feature requests are always appreciated, as well!