Skip to content

Commit

Permalink
Merge pull request doomemacs#5080 from fuzzycode/bl/vi-tilde-fringe/d…
Browse files Browse the repository at this point in the history
…ocumentation

Add vi-tilde-fringe documentation
  • Loading branch information
hlissner authored May 22, 2021
2 parents f015a5e + 90d1a59 commit 3ff8ff3
Showing 1 changed file with 42 additions and 0 deletions.
42 changes: 42 additions & 0 deletions modules/ui/vi-tilde-fringe/README.org
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
#+TITLE: ui/vi-tilde-fringe
#+DATE: May 22, 2021
#+SINCE: v2.0.5
#+STARTUP: inlineimages nofold

* Table of Contents :TOC_3:noexport:
- [[#description][Description]]
- [[#maintainers][Maintainers]]
- [[#module-flags][Module Flags]]
- [[#plugins][Plugins]]
- [[#prerequisites][Prerequisites]]
- [[#configuration][Configuration]]

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

** Maintainers
This module has no dedicated maintainers.

** Module Flags
This module provides no flags.

** Plugins
+ [[https://github.com/syl20bnr/vi-tilde-fringe][vi-tilde-fringe]]

* Prerequisites
This module has no prerequisites.

* 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 ~/.doom.d/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 ~/.doom.d/config.el
(add-hook 'org-mode-hook #'vi-tilde-fringe-mode)
#+end_src

0 comments on commit 3ff8ff3

Please sign in to comment.