Initial Minimap Module
Created a new Minimap module based on minimap.el from ELPA the module sets some DOOM-specific config, and better defaults. Also added keybindings for it.
This commit is contained in:
parent
375faedb1b
commit
112b43fe9a
6 changed files with 72 additions and 2 deletions
48
modules/ui/minimap/README.org
Normal file
48
modules/ui/minimap/README.org
Normal file
|
@ -0,0 +1,48 @@
|
|||
#+TITLE: Minimap
|
||||
#+DATE: May 8, 2020
|
||||
#+SINCE: v2.0
|
||||
#+STARTUP: inlineimages nofold
|
||||
|
||||
* Table of Contents :TOC_3:noexport:
|
||||
- [[#description][Description]]
|
||||
- [[#maintainers][Maintainers]]
|
||||
- [[#module-flags][Module Flags]]
|
||||
- [[#plugins][Plugins]]
|
||||
- [[#hacks][Hacks]]
|
||||
- [[#features][Features]]
|
||||
- [[#configuration][Configuration]]
|
||||
- [[#troubleshooting][Troubleshooting]]
|
||||
- [[#scrolling-is-slowlaggy][Scrolling is slow/laggy]]
|
||||
- [[#minimap-doesnt-close-when-disabled][Minimap doesn't close when disabled]]
|
||||
|
||||
* Description
|
||||
This module adds a minimap to the right side of Emacs, similar to the feature
|
||||
found in many other editors.
|
||||
|
||||
** Maintainers
|
||||
+ [[https://github.com/rushsteve1][@rushsteve1]] (Author)
|
||||
|
||||
** Module Flags
|
||||
This module provides no flags.
|
||||
|
||||
** Plugins
|
||||
+ [[https://elpa.gnu.org/packages/minimap.html][minimap.el]]
|
||||
|
||||
** Hacks
|
||||
+ The colors used by the minimap are terrible so are overridden with
|
||||
=custom-set-faces!= using colors out of the current DOOM theme.
|
||||
|
||||
* Features
|
||||
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.
|
||||
|
||||
* Configuration
|
||||
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 =SPC h v minimap=.
|
||||
|
||||
* Troubleshooting
|
||||
** Scrolling is slow/laggy
|
||||
Disable the minimap using =SPC t m=
|
||||
|
||||
** TODO Minimap doesn't close when disabled
|
Loading…
Add table
Add a link
Reference in a new issue