branch: externals/topspace commit 532509d6ce9141ef8d15b32210a669ca969c8bd3 Author: Trevor Pogue <trevorpo...@gmail.com> Commit: GitHub <nore...@github.com>
Make README prettier --- README.md | 33 ++++++++++++++++----------------- 1 file changed, 16 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index d7a6dc0251..f1a9d9dbb1 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,27 @@ -# TopSpace +<h1 align="center"> TopSpace </h1> +<p align="center"> + <a href="http://melpa.org/#/topspace"><img src="http://melpa.org/packages/topspace-badge.svg" height="20"/></a> + <a href="http://stable.melpa.org/#/topspace"><img src="http://stable.melpa.org/packages/topspace-badge.svg" height="20"/></a> + <a href="https://www.gnu.org/licenses/gpl-3.0"><img src="https://img.shields.io/badge/License-GPLv3-blue.svg" height="20"/></a> +</p> +<p align="center">Scroll above the top line.</p> +<br/> -[](http://melpa.org/#/topspace) -[](http://stable.melpa.org/#/topspace) -[](https://www.gnu.org/licenses/gpl-3.0) +<p align="center"><img src="https://user-images.githubusercontent.com/12535207/155176914-87390537-10f0-4ee5-9b37-cd798f07df27.gif" /></a></p> -**Scroll above the top line** +# Overview - +TopSpace is an Emacs minor mode that lets you scroll above the top line to vertically center the top text or cursor with a scrollable top margin/padding. In particular, it is useful when using Emacs in full-screen/on large monitors. TopSpace is: -TopSpace is an Emacs minor mode that lets you scroll above the top line to vertically center top text or cursor with a scrollable top margin/padding. In particular, it is useful when using Emacs in full-screen/on large monitors. +* **Easy to setup**: +No new keybindings are required, keep using all your previous scrolling commands. -### Just install and go: - -No new keybindings are required as `topspace` automatically works for any -commands or subsequent function calls which use `scroll-up`, `scroll-down`, -or `recenter` as the underlying primitives for scrolling. This includes all -scrolling commands/functions available in Emacs as far as the author is aware. - -### How it works: +* **Compatible with [centered-cursor-mode][1]**: +Center the cursor all the way to the top line! +* **Using overlays**: The top "margin" is created by drawing an [overlay](https://www.gnu.org/software/emacs/manual/html_node/elisp/Overlays.html) before window-start which contains nothing but newline characters. As you scroll, more newline characters are added or removed accordingly. -Bonus: If you use [`centered-cursor-mode`][1], this means that `topspace` will automatically let you center the cursor all the way to the top line! - # Installation TopSpace is available on [MELPA](http://melpa.org).