From ea9126a883d221b1ebb3d5186c29ee5bcab6c901 Mon Sep 17 00:00:00 2001
From: Henrik Lissner <henrik@lissner.net>
Date: Fri, 20 Dec 2019 01:09:59 -0500
Subject: [PATCH] ui/zen: add README.org & 'SPC t z' keybind

---
 modules/config/default/+evil-bindings.el |  3 +-
 modules/ui/zen/README.org                | 44 ++++++++++++++++++++++++
 2 files changed, 46 insertions(+), 1 deletion(-)
 create mode 100644 modules/ui/zen/README.org

diff --git a/modules/config/default/+evil-bindings.el b/modules/config/default/+evil-bindings.el
index 50f80b369..27d556271 100644
--- a/modules/config/default/+evil-bindings.el
+++ b/modules/config/default/+evil-bindings.el
@@ -621,7 +621,8 @@
           :desc "Flyspell"                   "s" #'flyspell-mode)
         (:when (featurep! :lang org +pomodoro)
           :desc "Pomodoro timer"             "t" #'org-pomodoro)
-        :desc "Word-wrap mode"               "w" #'+word-wrap-mode))
+        :desc "Word-wrap mode"               "w" #'+word-wrap-mode
+        :desc "Zen mode"                     "z" #'writeroom-mode))
 
 (after! which-key
   (let ((prefix-re (regexp-opt (list doom-leader-key doom-leader-alt-key))))
diff --git a/modules/ui/zen/README.org b/modules/ui/zen/README.org
new file mode 100644
index 000000000..8ad06abce
--- /dev/null
+++ b/modules/ui/zen/README.org
@@ -0,0 +1,44 @@
+#+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).