docs(:ui): update READMEs to new format
This commit is contained in:
parent
6da20e45bd
commit
b5a2aa48fe
25 changed files with 1533 additions and 922 deletions
|
@ -1,43 +1,61 @@
|
|||
#+TITLE: :ui minimap
|
||||
#+DATE: May 8, 2020
|
||||
#+SINCE: v3.0.0
|
||||
#+STARTUP: inlineimages nofold
|
||||
← [[doom-module-index:][Back to module index]] ↙ [[doom-module-issues:::ui minimap][Issues]] ↖ [[doom-module-source:ui/minimap][Source]] ± [[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
|
||||
|
||||
* Table of Contents :TOC_3:noexport:
|
||||
- [[#description][Description]]
|
||||
- [[#maintainers][Maintainers]]
|
||||
- [[#module-flags][Module Flags]]
|
||||
- [[#plugins][Plugins]]
|
||||
- [[#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.
|
||||
* Description :unfold:
|
||||
This module displays a minimap of the buffer in a sidebar, similar to the
|
||||
feature found in many other editors.
|
||||
|
||||
** Maintainers
|
||||
+ [[https://github.com/rushsteve1][@rushsteve1]] (Author)
|
||||
- [[doom-user:][@rushsteve1]]
|
||||
|
||||
** Module Flags
|
||||
This module provides no flags.
|
||||
[[doom-contrib-maintainer:][Become a maintainer?]]
|
||||
|
||||
** Plugins
|
||||
+ [[https://elpa.gnu.org/packages/minimap.html][minimap.el]]
|
||||
** 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
|
||||
|
||||
* 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
|
||||
* 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 =SPC h v minimap=.
|
||||
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 =SPC t m=
|
||||
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
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue