emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Add documentation for the fold module

Browse source
This commit is contained in:
George Xanthakis 2020-10-24 00:27:09 +03:00
parent 848e117e24
commit 3afc81662a
1 changed files with 22 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

32
modules/editor/fold/README.org
View file

@ -4,13 +4,13 @@
#+STARTUP: inlineimages #+STARTUP: inlineimages
* Table of Contents :TOC_3:noexport: * Table of Contents :TOC_3:noexport:
- [[Description][Description]] - [[#description][Description]]
- [[Module Flags][Module Flags]] - [[#module-flags][Module Flags]]
- [[Plugins][Plugins]] - [[#plugins][Plugins]]
- [[Prerequisites][Prerequisites]] - [[#prerequisites][Prerequisites]]
- [[Features][Features]] - [[#features][Features]]
- [[Configuration][Configuration]] - [[#configuration][Configuration]]
- [[Troubleshooting][Troubleshooting]] - [[#troubleshooting][Troubleshooting]]
* Description * Description
This module marries hideshow, vimish-fold and outline-minor-mode to bring you This module marries hideshow, vimish-fold and outline-minor-mode to bring you
@ -20,13 +20,25 @@ marker, indent and syntax-based code folding for as many languages as possible.
This module provides no flags. This module provides no flags.
** Plugins ** Plugins
+ evil-vimish-fold* +[[https://github.com/alexmurray/evil-vimish-fold][evil-vimish-fold]]
+[[https://github.com/matsievskiysv/vimish-fold][vimish-fold]]
* Prerequisites * Prerequisites
This module has no prerequisites. This module has no prerequisites.
* TODO Features * Features
Emacs keybinds when evil +everywhere is disabled.
| Keybind | Description |
|--------------------+---------------------------|
| =C-c f v= | Fold region |
| =C-c f a v= | Refold all regions |
| =C-c u v= or =C `= | Unfold region |
| =C-c u a v= | Unfold all regions |
| =C-c d v= | Delete folded region |
| =C-c d a v= | Delete all folded regions |
* TODO Configuration * TODO Configuration
* TODO Troubleshooting * Troubleshooting
Sometimes an unfolded region does not fold back with =C-c f v=. To bypass this bug you must delete the folded region (=C-c d v=) and then fold it(=C-c f v=) again.