[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/topspace 532509d6ce 036/181: Make README prettier
From: |
ELPA Syncer |
Subject: |
[elpa] externals/topspace 532509d6ce 036/181: Make README prettier |
Date: |
Tue, 23 Aug 2022 12:58:31 -0400 (EDT) |
branch: externals/topspace
commit 532509d6ce9141ef8d15b32210a669ca969c8bd3
Author: Trevor Pogue <trevorpogue@gmail.com>
Commit: GitHub <noreply@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/>
-[![MELPA](http://melpa.org/packages/topspace-badge.svg)](http://melpa.org/#/topspace)
-[![MELPA
Stable](http://stable.melpa.org/packages/topspace-badge.svg)](http://stable.melpa.org/#/topspace)
-[![License: GPL
v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](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](https://user-images.githubusercontent.com/12535207/155176914-87390537-10f0-4ee5-9b37-cd798f07df27.gif)
+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).
- [elpa] externals/topspace 1049ef1b0e 019/181: Make topspace-enable and topspace-disable private functions, (continued)
- [elpa] externals/topspace 1049ef1b0e 019/181: Make topspace-enable and topspace-disable private functions, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace e5b65eccf9 010/181: Update and rename vertical-center-mode.el to topspace.el, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 960c5cae34 022/181: Reflect changes to customization variable docstrings, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace c8161ec68e 013/181: Update topspace.el, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 164e4aa1b9 026/181: Make auto-center-buffers update buffer in Emacs 26 when mode is first turned on, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 4a69b2eb74 027/181: Fix issue when calling recenter or recenter-top-bottom interactively, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 8a6225639b 030/181: Update to more clear GIF in README, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace f92cefa47c 032/181: Expand upon customization options in README, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 919774a212 033/181: Expand upon customization options in README, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 25841387a5 035/181: Raise topspace-center-position default to an objectively better position, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 532509d6ce 036/181: Make README prettier,
ELPA Syncer <=
- [elpa] externals/topspace 24f0d8b35a 037/181: Update README header, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 94fe4ccf4c 038/181: Update README header, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 820107a73a 039/181: Update README header, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace a03735ae80 040/181: Add supporters section and emojis to README, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 99237026bc 045/181: Fix link in README, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 88b3be676e 048/181: Update README.md, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 5d30dd0957 052/181: Update README.md, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace da393d3573 053/181: Fix `recenter-top-bottom` bug, add .md files, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace dcd89f601e 054/181: Fix link in CONTRIBUTING.ms, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 472751c282 062/181: Update feature_request.md, ELPA Syncer, 2022/08/23