doomemacs/modules/ui/vi-tilde-fringe/README.org
Henrik Lissner 88844e9cec docs: simplify internal docs links
Fewer links means less confusion.

- Merge doom-issue and doom-commit links into doom-ref (for auto-linking
  Issue/PR/commit references).
- Merge doom-module-source and doom-docs-source links into doom-source.
- Rename doom-report-issue to doom-report.
- Use '!' as the icon for module issues link.
- Remove doom-repo (replaced with "doom:*" in :lang org module).
- Add doomdir and emacsdir links to :lang org module.
2021-11-21 20:04:28 +01:00

62 lines
1.9 KiB
Org Mode

← [[doom-module-index:][Back to module index]] ! [[doom-module-issues:::ui vi-tilde-fringe][Issues]] ↖ [[doom-source:modules/ui/vi-tilde-fringe/][Github]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]]
--------------------------------------------------------------------------------
#+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