doomemacs/modules/ui/zen/README.org

45 lines
1.3 KiB
Org Mode
Raw Normal View History

#+TITLE: ui/zen
#+DATE: December 20, 2019
#+SINCE: v3.0.0
#+STARTUP: inlineimages
* Table of Contents :TOC_3:noexport:
- [[#description][Description]]
- [[#module-flags][Module Flags]]
- [[#plugins][Plugins]]
- [[#prerequisites][Prerequisites]]
- [[#features][Features]]
- [[#distractions-free-mode][Distractions-free mode]]
- [[#configuration][Configuration]]
- [[#enable-fullscreen-on-activation][Enable fullscreen on activation]]
* Description
This module provides a distraction-free mode that:
+ Centers the buffer
+ Enables variable pitch for text (but keeps certain elements fixed-pitch).
+ Reduces UI clutter (e.g. the modeline; fullscreens the frame -- off by default)
** Module Flags
This module provides no flags.
** Plugins
+ [[https://github.com/joostkremers/writeroom-mode][writeroom-mode]]
+ [[https://gitlab.com/jabranham/mixed-pitch][mixed-pitch]]
* Prerequisites
This module has no prereqisites.
* Features
** Distractions-free mode
This can be activated with =SPC t z= for evil users. There is no keybinding for
non-evil users yet, so use 'M-x writeroom-mode'.
* Configuration
** Enable fullscreen on activation
#+BEGIN_SRC elisp
(setq writeroom-fullscreen-effect t)
#+END_SRC
Or fullscreen manually with =SPC t F= (or =F11= for non-evil users).