1abcf913aa
emacs-straight/org-mode@e22b4eb7aa introduced a breaking change that made it impossible to rely on .dir-locals.el to change org-mode buffers in $EMACSDIR to doom-docs-org-mode (without infinite recursion), so we used file-local variables in7e400ab. emacs-straight/org-mode@215de6176b reverted that change, so we can use .dir-locals.el again, and this is my preference, since it requires less boilerplate across our hundreds of org files. Ref: emacs-straight/org-mode@215de6176b Ref: emacs-straight/org-mode@e22b4eb7aa Revert:7e400abdc0
59 lines
1.6 KiB
Org Mode
59 lines
1.6 KiB
Org Mode
#+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
|