doomemacs/modules/editor/fold/README.org

#+TITLE:   editor/fold
#+DATE:    February 17, 2019
#+SINCE:   v2.1
#+STARTUP: inlineimages

* Table of Contents :TOC_3:noexport:
- [[#description][Description]]
  - [[#module-flags][Module Flags]]
  - [[#plugins][Plugins]]
- [[#prerequisites][Prerequisites]]
- [[#features][Features]]
- [[#configuration][Configuration]]
- [[#troubleshooting][Troubleshooting]]

* Description
This module marries hideshow, vimish-fold and outline-minor-mode to bring you
marker, indent and syntax-based code folding for as many languages as possible.

** Module Flags
This module provides no flags.

** Plugins
+ [[https://github.com/alexmurray/evil-vimish-fold][evil-vimish-fold]]
+ [[https://github.com/matsievskiysv/vimish-fold][vimish-fold]]

* Prerequisites
This module has no prerequisites.

* Features

Emacs keybinds when evil +everywhere is disabled.
| Keybind                | Description               |
|------------------------+---------------------------|
| =C-c C-f C-f=          | Fold region               |
| =C-c C-f C-u= or =C `= | Unfold region             |
| =C-c C-f C-d=          | Delete folded region      |
| =C-c C-f C-a C-f=      | Fold all regions          |
| =C-c C-f C-a C-u=      | Unfold all regions        |
| =C-c C-a C-d=          | Delete all folded regions |

* TODO Configuration

* Troubleshooting
Sometimes an unfolded region does not fold back with =C-c C-f C-f=. To bypass this bug you must delete the folded region (=C-c C-f C-d=) and then fold it(=C-c C-f C-f=) again.