merge: rewrite-docs
I've omitted docs/*.org from this merge, as there is still work left to do there, but I am pushing the module docs early so folks can benefit from the new docs sooner.
This commit is contained in:
commit
1f8bf7accb
179 changed files with 13125 additions and 8630 deletions
|
@ -1,44 +1,70 @@
|
|||
#+TITLE: editor/fold
|
||||
#+DATE: February 17, 2019
|
||||
#+SINCE: v2.1
|
||||
#+STARTUP: inlineimages
|
||||
# -*- mode: doom-docs-org -*-
|
||||
#+title: :editor fold
|
||||
#+subtitle: What you can't see won't hurt you
|
||||
#+created: May 15, 2019
|
||||
#+since: 21.12.0
|
||||
|
||||
* 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
|
||||
* Description :unfold:
|
||||
This module marries [[doom-package:][hideshow]], [[doom-package:][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.
|
||||
** Maintainers
|
||||
- [[doom-user:][@hlissner]]
|
||||
|
||||
** Plugins
|
||||
+ [[https://github.com/alexmurray/evil-vimish-fold][evil-vimish-fold]]
|
||||
+ [[https://github.com/matsievskiysv/vimish-fold][vimish-fold]]
|
||||
[[doom-contrib-maintainer:][Become a maintainer?]]
|
||||
|
||||
* Prerequisites
|
||||
This module has no prerequisites.
|
||||
** Module flags
|
||||
/This module has no flags./
|
||||
|
||||
* Features
|
||||
** Packages
|
||||
- [[doom-package:][evil-vimish-fold]]
|
||||
- [[doom-package:][vimish-fold]]
|
||||
- if [[doom-module:][:tools tree-sitter]]
|
||||
- [[doom-package:][ts-fold]]
|
||||
|
||||
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 Hacks
|
||||
#+begin_quote
|
||||
🔨 This module's hacks haven't been documented yet. [[doom-contrib-module:][Document them?]]
|
||||
#+end_quote
|
||||
|
||||
** TODO Changelog
|
||||
# This section will be machine generated. Don't edit it by hand.
|
||||
/This module does not have a changelog yet./
|
||||
|
||||
* Installation
|
||||
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
|
||||
|
||||
/This module has no external requirements./
|
||||
|
||||
* TODO Usage
|
||||
#+begin_quote
|
||||
🔨 /This module's usage documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
|
||||
#+end_quote
|
||||
|
||||
Emacs keybinds when [[doom-module:][:editor evil +everywhere]] is disabled:
|
||||
| Keybind | Description |
|
||||
|--------------------+---------------------------|
|
||||
| [[kbd:][C-c C-f C-f]] | Fold region |
|
||||
| [[kbd:][C-c C-f C-u]] or [[kbd:][C `]] | Unfold region |
|
||||
| [[kbd:][C-c C-f C-d]] | Delete folded region |
|
||||
| [[kbd:][C-c C-f C-a C-f]] | Fold all regions |
|
||||
| [[kbd:][C-c C-f C-a C-u]] | Unfold all regions |
|
||||
| [[kbd:][C-c C-a C-d]] | Delete all folded regions |
|
||||
|
||||
* TODO Configuration
|
||||
#+begin_quote
|
||||
🔨 This module has no configuration documentation yet. [[doom-contrib-module:][Write some?]]
|
||||
#+end_quote
|
||||
|
||||
* 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.
|
||||
- Sometimes, an unfolded region won't fold back with [[kbd:][C-c C-f C-f]]. To bypass this
|
||||
bug you must delete the folded region ([[kbd:][C-c C-f C-d]]) and then fold it ([[kbd:][C-c C-f
|
||||
C-f]]) again.
|
||||
|
||||
* 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