[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/topspace d19151de61 044/181: Refine README
From: |
ELPA Syncer |
Subject: |
[elpa] externals/topspace d19151de61 044/181: Refine README |
Date: |
Tue, 23 Aug 2022 12:58:32 -0400 (EDT) |
branch: externals/topspace
commit d19151de61116f24266bbc03161f5df4c24fd557
Author: Trevor Pogue <trevorpogue@gmail.com>
Commit: GitHub <noreply@github.com>
Refine README
---
README.md | 87 ++++++++++++++++++++++++++++++++++++---------------------------
1 file changed, 50 insertions(+), 37 deletions(-)
diff --git a/README.md b/README.md
index 703af30b4b..b9a8eda2c6 100644
--- a/README.md
+++ b/README.md
@@ -7,73 +7,86 @@
<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">
+<a
href="https://github.com/trevorpogue/topspace#hammer_and_wrench-Installation">
Installation </a> |
+<a href="https://github.com/trevorpogue/topspace#gear-customization">
Customization</a> |
+<a
href="https://github.com/trevorpogue/topspace#hammer_and_pick-extra-commands">
Extra commands</a> |
+<a href="https://github.com/trevorpogue/topspace#chains--supporters">
Supporters </a>
+</p>
+
<p align="center"><img
src="https://user-images.githubusercontent.com/12535207/155176914-87390537-10f0-4ee5-9b37-cd798f07df27.gif"
/></a></p>
-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 the top text or cursor with a scrollable top margin/padding.
-* **Easy to setup**:
+TopSpace is:
+
+* **Easier on the eyes**: Pull down the top text to a more comfortable eye
level for reading, especially when in full-screen or on a large monitor.
+
+* **Easy to use**:
No new keybindings are required, keep using all your previous scrolling
commands.
* **Compatible with [centered-cursor-mode][1]**:
Center the cursor all the way to the top line!
+<!-- <br/> -->
-* **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.
+<!-- **Table of contents**: -->
# :hammer_and_wrench: Installation
TopSpace is available on [MELPA](http://melpa.org).
After [installing MELPA](https://melpa.org/#/getting-started) you can install
TopSpace with the following command:
-<kbd>M-x</kbd> `package-install` <kbd>[RET]</kbd> `topspace` <kbd>[RET]</kbd>
+ <kbd>M-x</kbd> `package-install` <kbd>[RET]</kbd>
`topspace` <kbd>[RET]</kbd>
-If `topspace` did not appear here in `package-install` try running
<kbd>M-x</kbd> `package-refresh-contents` and repeating the above step. Then
enable TopSpace locally with <kbd>M-x</kbd> `topspace-mode`, or globally with
<kbd>M-x</kbd> `global-topspace-mode`.
-Alternatively, add `(global-topspace-mode 1)` to your Emacs config to enable
`topspace-mode` globally on startup.
+If `topspace` did not appear here in `package-install` try running
<kbd>M-x</kbd> `package-refresh-contents` and repeating the above step.
-# :gear: Customization
-By default, small buffers will be vertically centered with top space when
first opened. To disable this feature, simply add the following to your Emacs
config:
-```
-(custom-set-variables '(topspace-autocenter-buffers nil))
+Then enable TopSpace locally with
+
+ <kbd>M-x</kbd> `topspace-mode`,
+
+or globally with
+
+ <kbd>M-x</kbd> `global-topspace-mode`.
+
+To enable `topspace-mode` globally on startup, add the following to your Emacs
config:
```
-More options/detail:
+(global-topspace-mode 1)
```
-(defcustom topspace-autocenter-buffers
- t
- "Vertically center small buffers when first opened or window sizes change.
-This is done by automatically calling `topspace-recenter-buffer',
-which adds enough top space to center small buffers.
+# :gear: Customization
+### `topspace-autocenter-buffer`
+* Description: By default, small buffers will be vertically centered with top
space when first opened by calling `topspace-recenter-buffer` (described below).
Top space will not be added if the number of text lines in the buffer is larger
than or close to the selected window's height.
-Customize `topspace-center-position' to adjust the centering position."
- :group 'topspace
- :type 'boolean)
-
-(defcustom topspace-center-position
- 0.4
- "Target position when centering buffers as a ratio of frame height.
-A value from 0 to 1 where lower values center buffers higher up in the screen.
-
-Used in `topspace-recenter-buffer' when called or when opening/resizing buffers
-if `topspace-autocenter-buffers' is non-nil."
- :group 'topspace
- :type 'float)
+Customize `topspace-center-position` (described below) to adjust the centering
position.
+* Default value: t
+* Type: boolean
+* How to modify: Disable this feature by adding the following to your Emacs
config:
+```
+(custom-set-variables '(topspace-autocenter-buffers nil))
```
-# :hammer_and_pick: Extra commands
-
-### `topspace-recenter-buffer`:
+### `topspace-center-position`
+* Description: Target position when centering buffers as a ratio of frame
height. It must be a value from 0 to 1 where lower values center buffers higher
up in the screen. Used in `topspace-recenter-buffer` (described below) when
called or when opening/resizing buffers if `topspace-autocenter-buffers` is
non-nil.
+* Default value: 0.4
+* Type: float
+* How to modify: Add the following to your Emacs config:
+```
+(custom-set-variables '(topspace-center-position <custom value>))
+```
-Add enough top space in the selected window to center small buffers.
+# :hammer_and_pick: Extra commands
+### `topspace-recenter-buffer`
+* Add enough top space in the selected window to center small buffers.
Top space will not be added if the number of text lines in the buffer is larger
than or close to the selected window's height.
-
Customize `topspace-center-position` to adjust the centering position.
Customize `topspace-autocenter-buffers` to run this command automatically
after first opening buffers and after window sizes change.
-# :chains: Supporters
+
+# :chains: Supporters
### ↳ Stargazers
[![Stargazers repo roster for
@trevorpogue/topspace](https://reporoster.com/stars/trevorpogue/topspace)](https://github.com/trevorpogue/topspace/stargazers)
@@ -83,4 +96,4 @@ after first opening buffers and after window sizes change.
<br/>
<p align="center"><a href="https://github.com/trevorpogue/topspace#"><img
src="http://randojs.com/images/backToTopButtonTransparentBackground.png"
alt="Back to top" height="29"/></a></p>
- [1]: https://github.com/andre-r/centered-cursor-mode.el
+[1]: https://github.com/andre-r/centered-cursor-mode.el
- [elpa] externals/topspace 512893f002 021/181: Provide documentation strings for private variables, (continued)
- [elpa] externals/topspace 512893f002 021/181: Provide documentation strings for private variables, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 976971f4a9 024/181: Add clarification to Installation steps, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace f36c0e28af 025/181: Add MELPA Stable badge, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 73cb30dc10 028/181: Add more info on how it works to README, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 8591032298 029/181: Add to package motivation in README, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace a76d4f3612 031/181: Update to more clear GIF in README, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 4eb27abaa1 034/181: Prevent top space from all suddenly disappearing when visual-line-mode is enabled and cursor scrolls bellow screen with top space present, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 7a3c9703a5 041/181: Fix links in README, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace c6bc481049 042/181: Fix links in README, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 7303661244 043/181: Update headers in README, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace d19151de61 044/181: Refine README,
ELPA Syncer <=
- [elpa] externals/topspace ba7eba3d49 046/181: Make README more concise, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 66373896ec 047/181: Update README.md, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 1b08e734ec 049/181: Update README.md, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace cbdcdff484 051/181: Fix `recenter-top-bottom` bug, add .md files, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 0d5a7cbc63 055/181: Update README.md, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace cb918d1c44 057/181: Create PULL_REQUEST_TEMPLATE.md, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 9e24080d3a 060/181: Update feature_request.md, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace fda0548e98 061/181: Update bug_report.md, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace abc4a0f8c1 058/181: Update PULL_REQUEST_TEMPLATE.md, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 06316cb9d4 073/181: Update link to include noun, ELPA Syncer, 2022/08/23