doomemacs/modules/ui/nav-flash/README.org

66 lines
2.1 KiB
Org Mode
Raw Normal View History

← [[doom-module-index:][Back to module index]] ! [[doom-module-issues:::ui nav-flash][Issues]] ↖ [[doom-source:modules/ui/nav-flash/][Github]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]]
--------------------------------------------------------------------------------
#+TITLE: :ui nav-flash
#+SUBTITLE: Blink after big motions
#+CREATED: June 04, 2017
#+SINCE: 2.0.0
* Description :unfold:
2019-04-23 14:12:26 -04:00
This module flashes the line around the cursor after any significant motion, to
make it easy to follow after big operations.
#+begin_quote
💡 Tremendously helpful on large, 1600p+ or 4K displays.
#+end_quote
** Maintainers
- [[doom-user:][@hlissner]]
[[doom-contrib-maintainer:][Become a maintainer?]]
** Module flags
/This module has no flags./
** Packages
- [[doom-package:][nav-flash]]
** Hacks
/No hacks documented for this module./
** TODO Changelog
# This section will be machine generated. Don't edit it by hand.
/This module does not have a changelog yet./
* Installation
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
2017-08-21 20:07:07 +02:00
/This module has no external requirements./
* Usage
By default, [[doom-package:][nav-flash]] will be triggered whenever [[fn:][recenter]] is called or an entry
is added to the jump-list (managed by [[doom-package:][better-jumper]]).
[[fn:][recenter]] is called after many hooks and commands, such as:
- [[var:][better-jumper-post-jump-hook]]
- [[var:][rtags-after-find-file-hook]]
- [[var:][org-follow-link-hook]]
- [[var:][imenu-after-jump-hook]]
- [[var:][counsel-grep-post-action-hook]]
- [[var:][dumb-jump-after-jump-hook]]
* TODO Configuration
#+begin_quote
🔨 This module has no configuration documentation yet. [[doom-contrib-module:][Write some?]]
#+end_quote
* Troubleshooting
/There are no known problems with this module./ [[doom-report:][Report one?]]
* Frequently asked questions
/This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]]
* TODO Appendix
#+begin_quote
🔨 This module has no appendix yet. [[doom-contrib-module:][Write one?]]
#+end_quote