scrollkeeper

Custom scrolling commands with visual guidelines


Keywords
convenience, emacs
License
GPL-3.0

Documentation

scrollkeeper.el

https://melpa.org/packages/scrollkeeper-badge.svg https://stable.melpa.org/packages/scrollkeeper-badge.svg

This package provides scrolling commands and several customization options. The commands use pulse to display a quickly fading guideline, or another chosen style, on the line at which new contents are visible after scrolling. Also, scrolling can be divided into steps which proceed at the desired speed. Together, these features help your eyes to keep their place in the buffer while scrolling.

Screencast

It’s hard to capture in a GIF, but here is a video demonstration (view on Imgur).

Contents

Installation

MELPA

Just install from MELPA, then bind the commands and customize the scrollkeeper group as desired.

Quelpa

quelpa-use-package makes it easy to install, and general makes it easy to configure key bindings:

(use-package scrollkeeper
  :quelpa (scrollkeeper :fetcher github :repo "alphapapa/scrollkeeper.el")
  :general ([remap scroll-up-command] #'scrollkeeper-contents-up
            [remap scroll-down-command] #'scrollkeeper-contents-down))

Usage

Run one of these commands:

  • scrollkeeper-up, scrollkeeper-contents-down: Scroll the window up, or the contents down, depending on your perspective.
  • scrollkeeper-down, scrollkeeper-contents-up: Scroll the window down, or the contents up, depending on your perspective.

Tips

  • You can customize settings in the scrollkeeper group.

Changelog

0.1

Initial release.

Credits

See also

These packages provide some similar functionality but in very different ways.

on-screen
A more complex and comprehensive implementation that uses hooks to observe scrolling in other windows.
highlight-context-line
Highlights the boundary line statically, using a minor mode rather than commands.
beacon
Highlights the cursor rather than the boundary line between new and old content.

Development

Bug reports, feature requests, suggestions — oh my!

License

GPLv3