mirrors/doomemacs
1
Fork 0
mirror of https://github.com/doomemacs/doomemacs.git synced 2026-05-16 08:31:54 -07:00
Code Issues Projects Releases Wiki Activity
doomemacs/modules/ui/minimap
History
Exact
Henrik Lissner bead7a7748
refactor!: backport mode-line-invisible-mode & drop hide-mode-line 
BREAKING CHANGE: If you are using the `hide-mode-line` package, use
`mode-line-invisible-mode` instead. This mode was introduced in Emacs
31, but has been backported since it is so widely used in Doom (and so
we can drop another core dependency).

There is no replacement for `global-hide-mode-line`, however. You'll
have to install `hide-mode-line` if you were using it.
2026-05-05 17:27:36 -04:00
..
.doommodule feat: add .doommodule files 2024-09-14 20:47:39 -04:00
config.el refactor!: backport mode-line-invisible-mode & drop hide-mode-line 2026-05-05 17:27:36 -04:00
packages.el refactor(minimap): replace minimap.el w/ demap.el 2025-06-29 17:35:56 +02:00
README.org docs(minimap): update & expand 2025-11-04 21:45:57 -05:00

README.org

:ui minimap

Description   unfold

This module displays a minimap of the buffer in a sidebar, similar to the feature found in many other editors.

Maintainers

This module has no dedicated maintainers. Become a maintainer?

Module flags

This module has no flags.

Packages

Hacks

No hacks documented for this module.

TODO Changelog

This module does not have a changelog yet.

Usage

Press SPC t m to toggle the minimap.

A minimap provides an overview of the current buffer to the side, displaying the currently visible region and the current line. You can left-click inside the minimap to create a region, or scroll to move the minimap up & down.

Configuration

There are a number of options provided by the demap.el package this module is based on. The easiest way to see all of them is SPC h v demap.

Changing the side that the minimap window opens in

You can change the variable 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 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 demap-minimap-default-name variable controls the name of the minimap buffer, by default it is set to "**Minimap**".

Troubleshooting

There are no known problems with this module. Report one?

Frequently asked questions

This module has no FAQs yet. Ask one?

TODO Appendix

Variables

  • demap-minimap-change-major-mode-hook
  • 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