mirrors/doomemacs
1
Fork 0
mirror of https://github.com/doomemacs/doomemacs.git synced 2025-12-06 02:30:33 -08:00
Code Issues Projects Releases Wiki Activity

docs(minimap): update & expand

Browse source
This commit is contained in:
Yusef Aslam 2025-11-05 02:45:57 +00:00 • committed by GitHub
parent 2ac5787cc9
commit 5f0ebdf2e0
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 33 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

49
modules/ui/minimap/README.org
View file

@ -23,22 +23,30 @@ feature found in many other editors.
# This section will be machine generated. Don't edit it by hand. # This section will be machine generated. Don't edit it by hand.
/This module does not have a changelog yet./ /This module does not have a changelog yet./
* TODO Usage * Usage
#+begin_quote Press [[kbd:][SPC t m]] to toggle the minimap.
󱌣 /This module's usage documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
#+end_quote
A minimap which provides an overview of the current buffer to the side, A minimap provides an overview of the current buffer to the side, displaying the
displaying the currently visible region and the current line. You can left-click currently visible region and the current line. You can left-click inside the
and drag to scroll along the buffer, or right-click anywhere to jump to there. minimap to create a region, or scroll to move the minimap up & down.
* TODO Configuration * Configuration
#+begin_quote There are a number of options provided by the =demap.el= package this module
󱌣 /This module's configuration documentation is incomplete./ [[doom-contrib-module:][Complete it?]] is based on. The easiest way to see all of them is [[kbd:][SPC h v demap]].
#+end_quote
There are a number of options provided by the =minimap.el= package this module ** Changing the side that the minimap window opens in
is based on. The easiest way to see all of them is [[kbd:][SPC h v minimap]]. You can change the variable [[var:demap-minimap-window-side][demap-minimap-window-side]] which controls the side of
the frame the minimap window opens in, it supports these options:
- =right=
- =left=
** Changing the width of the minimap window
The [[var:demap-minimap-window-width][demap-minimap-window-width]] variable controls the width of the minimap
window, by default it is set to =20=.
** Changing the name of the minimap buffer
The [[var:demap-minimap-default-name][demap-minimap-default-name]] variable controls the name of the minimap buffer,
by default it is set to ="**Minimap**"=.
* Troubleshooting * Troubleshooting
/There are no known problems with this module./ [[doom-report:][Report one?]] /There are no known problems with this module./ [[doom-report:][Report one?]]
@ -47,6 +55,15 @@ is based on. The easiest way to see all of them is [[kbd:][SPC h v minimap]].
/This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]] /This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]]
* TODO Appendix * TODO Appendix
#+begin_quote ** Variables
󱌣 This module has no appendix yet. [[doom-contrib-module:][Write one?]] - demap-minimap-change-major-mode-hook
#+end_quote - demap-minimap-default-name
- demap-minimap-window-width
- demap-minimap-window-side
- demap-minimap-kill-hook
- demap-minimap-construct-hook
- demap-minimap-window-set-hook
- demap-minimap-change-functions
- demap-minimap-window-sleep-hook
- demap-minimap-protected-variables
- demap-minimap-close-kill-minimap-p