[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Bug#861124: RFP: elpa-writeroom-mode -- distraction-free writing for Emacs



Package: wnpp
Severity: wishlist

* Package name    : elpa-writeroom-mode
  Version         : 3.6.1
  Upstream Author : Joost Kremers <joostkremers@fastmail.fm>
* URL             : https://github.com/joostkremers/writeroom-mode
* License         : 3-clause BSD?
  Programming Lang: Elisp
  Description     : distraction-free writing for Emacs

writeroom-mode is a minor mode for Emacs that implements a
distraction-free writing mode similar to the famous Writeroom editor
for OS X. writeroom-mode is meant for GNU Emacs 24, lower versions are
not actively supported.

By default, writeroom-mode does the following things:

 * activate fullscreen
 * disable transparency
 * disable the menu bar
 * disable the tool bar
 * disable the scroll bar
 * enable a bottom window divider of 1 pixel
 * maximise the current window (i.e., delete all other windows in the
   frame)
 * place the fringes outside the margins
 * disable the mode line
 * add window margins to the current buffer so that the text is 80
   characters wide

The last three effects are buffer-local. The other effects apply to
the current frame. Because writeroom-mode is a minor mode, this isn't
entirely on the up and up, since minor modes aren't supposed to have
such global effects. But writeroom-mode is meant for distraction-free
writing, so these effects do make sense.

All these effects can be disabled or customised. In addition, there
are several more options that are disabled by default but can be
enabled in the customisation buffer.

----

I use this package to write long articles and things that need all my
focus. I don't think it has any other dependencies, and I use it
frequently - although I had to do some tweaks to make it work with
Xmonad.

There's another package called "darkroom-mode" that is similar, but
they didn't want to implement full-screen mode so I gave up on it.

I'd be happy to comaintain this with the elpa team if no one else
steps up.


Reply to: