Skip to content
A vim plugin to mimic the behavior of WriteRoom
VimL
Find file
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
doc
plugin
README.md

README.md

vim-writeroom

A vim WriteRoom Clone

vim-writeroom is a pathogen style vim plugin that will mimic the full-screen, distraction-free interface of WriteRoom. It is designed to be used alone or work in conjunction with other plugins.

Use

By default, the <F5> key is mapped to toggle vim-writeroom on and off. If this key is already bound, vim-writeroom will not override it. The line below is used internally to set up the binding. You can mimic the binding with your own key or sequence in your .vimrc file to customize its use.

nnoremap <F5> :call VimWriteRoom()<CR>

Note: there is a bug in MacVim on Lion that can create display issues in full-screen where the OS native background is displayed instead of vim's background. To fix this problem in the meantime, you can try running this command from your terminal window:

defaults write org.vim.MacVim MMNativeFullScreen 0

The following are a number of configuration variables that can be set to customize your vim-writeroom experience:

g:vimwriteroom = set to disable plugin
g:vimwriteroomcolorscheme = colorscheme to show in writeroom mode

Roadmap

  • Make <F5> or any call to VimWriteRoom() toggle the experience back and forth
  • Add support for configurable color options and various colorschemes
  • Add variable to use determine the use of the default toggle mapping
  • Fix full-screen issues in Lion
  • Expand help documents

Screenshot

Example of Use

Credits

vim-writeroom is written by James Tomasino. endorse

It was inspired, and much of the original code was lifted, from a blog post by Brandur.

Much thanks also goes to Steve Francia for his amazing spf13-vim, which helped me gain an understanding of vimL and learn to write a plugin.

Something went wrong with that request. Please try again.