88844e9cec
Fewer links means less confusion. - Merge doom-issue and doom-commit links into doom-ref (for auto-linking Issue/PR/commit references). - Merge doom-module-source and doom-docs-source links into doom-source. - Rename doom-report-issue to doom-report. - Use '!' as the icon for module issues link. - Remove doom-repo (replaced with "doom:*" in :lang org module). - Add doomdir and emacsdir links to :lang org module.
61 lines
1.9 KiB
Org Mode
61 lines
1.9 KiB
Org Mode
← [[doom-module-index:][Back to module index]] ! [[doom-module-issues:::ui minimap][Issues]] ↖ [[doom-source:modules/ui/minimap/][Github]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]]
|
|
--------------------------------------------------------------------------------
|
|
#+TITLE: :ui minimap
|
|
#+SUBTITLE: A map for lost programmers
|
|
#+CREATED: May 08, 2020
|
|
#+SINCE: 21.12.0
|
|
|
|
* Description :unfold:
|
|
This module displays a minimap of the buffer in a sidebar, similar to the
|
|
feature found in many other editors.
|
|
|
|
** Maintainers
|
|
- [[doom-user:][@rushsteve1]]
|
|
|
|
[[doom-contrib-maintainer:][Become a maintainer?]]
|
|
|
|
** Module flags
|
|
/This module has no flags./
|
|
|
|
** Packages
|
|
- [[doom-package:][minimap]]
|
|
|
|
** 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./
|
|
|
|
* TODO Usage
|
|
#+begin_quote
|
|
🔨 /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,
|
|
displaying the currently visible region and the current line. You can left-click
|
|
and drag to scroll along the buffer, or right-click anywhere to jump to there.
|
|
|
|
* TODO Configuration
|
|
#+begin_quote
|
|
🔨 /This module's configuration documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
|
|
#+end_quote
|
|
|
|
There are a number of options provided by the =minimap.el= package this module
|
|
is based on. The easiest way to see all of them is [[kbd:][SPC h v minimap]].
|
|
|
|
* Troubleshooting
|
|
[[doom-report:][Report an issue?]]
|
|
|
|
** Scrolling is slow/laggy
|
|
Disable the minimap using [[kbd:][SPC t m]].
|
|
|
|
** TODO Minimap doesn't close when disabled
|
|
|
|
* 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
|