Giter Club home page Giter Club logo

olivetti's Introduction

Olivetti

MELPA Stable MELPA

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

screenshot

Pictured: Big Fish by John August 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

  • 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

olivetti's People

Contributors

rnkn avatar sten0 avatar larstvei avatar smythp avatar syohex avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.