From 3afc81662af01a2c4dc503831a5b4b145b2bf040 Mon Sep 17 00:00:00 2001 From: George Xanthakis Date: Sat, 24 Oct 2020 00:27:09 +0300 Subject: [PATCH] Add documentation for the fold module --- modules/editor/fold/README.org | 32 ++++++++++++++++++++++---------- 1 file changed, 22 insertions(+), 10 deletions(-) diff --git a/modules/editor/fold/README.org b/modules/editor/fold/README.org index 55c93ff78..b74c128a8 100644 --- a/modules/editor/fold/README.org +++ b/modules/editor/fold/README.org @@ -4,13 +4,13 @@ #+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][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 @@ -20,13 +20,25 @@ marker, indent and syntax-based code folding for as many languages as possible. This module provides no flags. ** Plugins -+ evil-vimish-fold* ++[[https://github.com/alexmurray/evil-vimish-fold][evil-vimish-fold]] ++[[https://github.com/matsievskiysv/vimish-fold][vimish-fold]] * 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 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.