doomemacs/modules/ui/vi-tilde-fringe/README.org

#+title:    :ui vi-tilde-fringe
#+subtitle: Fringe tildes beyond EOB
#+created:  September 24, 2017
#+since:    2.0.6

* Description :unfold:
Displays a tilde(~) in the left fringe to indicate an empty line, similar to Vi.

** Maintainers
- [[doom-user:][@hlissner]]

[[doom-contrib-maintainer:][Become a maintainer?]]

** Module flags
/This module has no flags./

** Packages
- [[doom-package:vi-tilde-fringe]]

** 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./

* Installation
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]

/This module has no external requirements./

* Usage
Nothing more needs to be done once the module is activated. Tildes will become
visible in all buffers, after EOB.

* Configuration
By default, doom activates ~vi-tilde-fringe-mode~ for ~prog-mode~, ~text-mode~
and ~conf-mode~. To change this to your liking, you can remove any of the modes
from the list:
#+begin_src emacs-lisp
;; in $DOOMDIR/config.el
(remove-hook 'text-mode-hook #'vi-tilde-fringe-mode)
#+end_src

Or add new modes where you would like ~vi-tilde-fringe-mode~ enabled:
#+begin_src emacs-lisp
;; in $DOOMDIR/config.el
(add-hook 'org-mode-hook #'vi-tilde-fringe-mode)
#+end_src

* Troubleshooting
/There are no known problems with this module./ [[doom-report:][Report one?]]

* 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