org-hover

An Emacs package that provides hover preview functionality for org links.

Features

• Link Preview: Preview content of file links in org-mode
• Denote Link Support: Preview content of Denote links [[denote:IDENTIFIER][DESCRIPTION]]
• Block Preview: Preview specific files using native org-mode #+INCLUDE syntax within #+begin_quote blocks
• Smart Positioning: Intelligently position popup windows based on screen boundaries
• Adaptive Sizing: Automatically adjust preview window size based on content
• Auto-hide: Close popup by clicking outside or configure auto-hide after delay

Installation

Manual Installation

git clone https://github.com/VandeeFeng/org-hover.git

Then add to your init.el:

(add-to-list 'load-path "/path/to/org-hover")
(require 'org-hover)

Usage

Basic Usage:

1. In an org file, place cursor on an org file link
2. Press C-c h l to preview the link
3. Press C-c h f to preview any specified file
4. Press C-c h b to preview the #+begin_quote: block at point
5. Press C-c h B to preview the #+begin_quote: block at point ,and insert the content

INCLUDE Examples

All INCLUDE syntax follows the native org-mode #+INCLUDE syntax

Line Range Example

Get a hover preview of lines 1-30 of the file:

#+begin_quote
#+INCLUDE: "file.org" :lines "1-30"
#+end_quote

Header Example

get a hover preview of the section with its header included:

#+begin_quote
#+INCLUDE: "file.org::*Header"
#+end_quote

Full File Example

get a hover preview of the entire file content (limited to first 1000 characters):

#+begin_quote
#+INCLUDE: "file.org"
#+end_quote

⚠️Note: When auto-insert is enabled, the INCLUDE content will automatically replace and overwrite any existing content within the quote block.

Configuration Options

org-hover-auto-hide :

Whether to automatically hide the popup window. Disabled by default.

(setq org-hover-auto-hide t)  ; Default: nil (disabled)

org-hover-auto-hide-delay :

Delay in seconds before auto-hiding the popup window. Only effective when org-hover-auto-hide is enabled.

(setq org-hover-auto-hide-delay 5)  ; Default: 5 seconds

org-block-hover-auto-insert :

Whether to automatically insert the content to the quote block

(setq org-block-hover-auto-insert t) ; Default: nil