/olivetti

Emacs minor mode for a nice writing environment
  1. Emacs Lisp 100.0%
Emacs Lisp
Clone or download

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Open in Desktop Download ZIP
Find file
Switch branches/tags
Nothing to show
Latest commit cd2fdca Nov 3, 2017 @rnkn rnkn Added alt recommendation for writeroom-mode 
Closes #18
Permalink
Failed to load latest commit information.
screenshots new file: screenshots/01.png Aug 6, 2017
README.md Added alt recommendation for writeroom-mode Nov 3, 2017
TODO.md Added TODO.md Aug 24, 2017
olivetti.el Revert "Enhance short description" Nov 3, 2017

README.md

License GPL 3 MELPA Stable MELPA

Olivetti is a simple Emacs minor mode for a nice writing environment.

screenshot

Pictured: Big Fish by John August using using text body width of 66 (top, also using Fountain Mode), lorem ipsum text using text body width of 80 (bottom)

Features

  • Set a desired text body width to automatically resize window margins to keep the text comfortably in the middle of the window.
  • Text body width can be the number of characters (an integer) or a fraction of the window width (a float between 0.0 and 1.0).
  • Interactively change body width with:
    olivetti-shrink C-c [ [ [ ...
    olivetti-expand C-c ] ] ] ...
    olivetti-set-width C-c \
  • If olivetti-body-width is an integer, the text body width will scale with use of text-scale-mode, whereas if a fraction (float) then the text body width will remain at that fraction.
  • Optionally remember the state of visual-line-mode on entry and recall its state on exit.
  • Optionally hide the mode-line for distraction-free writing.

Olivetti keeps everything it does buffer-local, so you can write prose in one buffer and code in another, side-by-side in the same frame. Or, by hiding the mode-line and using a single window in a fullscreen frame, Olivetti provides a nice distraction-free environment. For those looking for a hardcore distraction-free writing mode with a much larger scope, I recommend writeroom-mode.

Requirements

  • Emacs 24.4

Installation

Olivetti is available through MELPA and MELPA-stable. I encourage installing the stable version.

Alternately, download the latest release and put it in your load-path.

Known Bugs

  • display-line-numbers-mode (included in Emacs 26.1) has a poor implementation that causes problems with modes that work with the text body width or margins. Discussion at https://debbugs.gnu.org/28248 and https://debbugs.gnu.org/28844. Use linum-mode instead.
  • linum-mode in Emacs versions earlier than 26.1 has a bug that overwrites margin settings, making it incompatible with modes that work with margins. More information here: https://debbugs.gnu.org/20674.

Please report bugs on GitHub Issues page.

History

See Releases.

Hints

To always use a different width for a specific file, set a File Variable specifying olivetti-body-width:

M-x add-file-local-variable RET olivetti-body-width RET 66 RET