doomemacs/modules/ui/minimap

:ui minimap

• Description
  • Maintainers
  • Module flags
  • Packages
  • Hacks
  • Changelog
• Usage
• Configuration
  • Changing the side that the minimap window opens in
  • Changing the width of the minimap window
  • Changing the name of the minimap buffer
• Troubleshooting
• Frequently asked questions
• Appendix
  • Variables

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

• doom-package:demap

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