Skip to content

Commit

Permalink
Added vim-zenroom: Remove all clutter and focus only on the essential…
Browse files Browse the repository at this point in the history
…. Similar to iA Writer or Write Room
  • Loading branch information
amix committed Dec 28, 2013
1 parent 08a64d9 commit 6bce69d
Show file tree
Hide file tree
Showing 8 changed files with 491 additions and 1 deletion.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,8 @@ I recommend reading the docs of these plugins to understand them better. Each of
* [vim-expand-region](https://github.com/terryma/vim-expand-region): Allows you to visually select increasingly larger regions of text using the same key combination.
* [vim-airline](https://github.com/bling/vim-airline): Lean & mean status/tabline for vim that's light as air (replacing powerline)
* [vim-fugitive](https://github.com/tpope/vim-fugitive): A Git wrapper so awesome, it should be illegal
* [vim-zenroom](https://github.com/amix/vim-zenroom):
Remove all clutter and focus only on the essential. Similar to iA Writer or Write Room [Read more here](http://amix.dk/blog/post/19744#zenroom-for-Vim-Focsuing-only-on-the-essential)


## What color schemes are included?
Expand Down Expand Up @@ -311,3 +313,5 @@ Vimscript mappings:
* [Vim 7.3: Persistent undo and encryption!](http://amix.dk/blog/post/19548#Vim-7-3-Persistent-undo-and-encryption)
* [Vim tips: Visual Search](http://amix.dk/blog/post/19334#Vim-tips-Visual-Search)
* [Folding in Vim](http://amix.dk/blog/post/19132#Folding-in-Vim)
* [
Zen room for Vim: Focsuing only on the essential](http://amix.dk/blog/post/19744#zenroom-for-Vim-Focsuing-only-on-the-essential)
12 changes: 12 additions & 0 deletions sources_non_forked/vim-zenroom/LICENSE.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Copyright (c) 2010 Mike West, http://mikewest.org/
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

Neither the name of the software nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
20 changes: 20 additions & 0 deletions sources_non_forked/vim-zenroom/README.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
This is my fork of Vimroom which includes following:

* A special mode for editing Markdown and reStructuredText. It's highly inspired by [iA Writer](http://writer.pro/)
* Optimizations for [my vimrc](https://github.com/amix/vimrc)

Pelase read more here [
zenroom for Vim: Focsuing only on the essential](http://amix.dk/blog/post/19744#zenroom-for-Vim-Focsuing-only-on-the-essential).


## Editing code

![Screenshot 1](http://amix.dk/uploads/zenroom_code.jpg)

![Screenshot 2](http://amix.dk/uploads/zenroom_code_1.jpg)

## Updating documentation

![Screenshot 3](http://amix.dk/uploads/zenroom_documentation.jpg)

![Screenshot 4](http://amix.dk/uploads/zenroom_documentation_1.jpg)
12 changes: 12 additions & 0 deletions sources_non_forked/vim-zenroom/doc/tags
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
g:vimroom_background vimroom.txt /*g:vimroom_background*
g:vimroom_min_sidebar_width vimroom.txt /*g:vimroom_min_sidebar_width*
g:vimroom_navigational_keys vimroom.txt /*g:vimroom_navigational_keys*
g:vimroom_scrolloff vimroom.txt /*g:vimroom_scrolloff*
g:vimroom_sidebar_height vimroom.txt /*g:vimroom_sidebar_height*
g:vimroom_width vimroom.txt /*g:vimroom_width*
vimroom vimroom.txt /*vimroom*
vimroom-about vimroom.txt /*vimroom-about*
vimroom-configuration vimroom.txt /*vimroom-configuration*
vimroom-installation vimroom.txt /*vimroom-installation*
vimroom-toc vimroom.txt /*vimroom-toc*
vimroom.txt vimroom.txt /*vimroom.txt*
86 changes: 86 additions & 0 deletions sources_non_forked/vim-zenroom/doc/vimroom.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
*vimroom.txt*

==============================================================================
TABLE OF CONTENTS *vimroom* *vimroom-toc*

1. About |vimroom-about|
2. Installation |vimroom-installation|
3. Configuration |vimroom-configuration|

==============================================================================
ABOUT *vimroom-about*

I do most of my writing in Vim, because I’m a big nerd. It does most of what
I want a writing environment to do, but I miss some of the “distraction free"
features of the quite exceptional WriteRoom. Fullscreening Vim means that text
ends up flat up against the left side of my monitor, but I’d much prefer it to
be centered. I’d also like a little of the visual clutter to fade away. Some
of this is possible with MacVim, but I’d rather do as much as possible in
a platform-independent way. So, command-line Vim it is.

For more visit:
http://projects.mikewest.org/vimroom/
https://github.com/mikewest/vimroom

==============================================================================
INSTALLATION *vimroom-installation*

I think the best way to install Vim plugins is via Tim Pope’s Pathogen. Using
that plugin, you can simply clone the VimRoom repository into your bundles
directory, and you’re done.

Without Pathogen, installation is almost as trivial: simply copy
./plugins/vimroom.vim from the repository into your plugins directory. That’s
it!

==============================================================================
CONFIGURATION *vimroom-configuration*

By default, VimRoom binds <Leader>V to <Plug>VimroomToggle, and sets up an 80
column workspace with at least 5 columns of space on either side (it doesn’t
help at all to have single-column sidebars, you see), and 3 lines of space
above and below. It assumes a black background when hiding visual
distractions. As of v0.4, VimRoom also sets up a :VimroomToggle command that
has the same effect.

Changing any of these assumptions is a simple matter of setting variables in
your .vimrc.

*g:vimroom_background*
is the background color to be used for hiding elements. Set this to your
terminal’s background color (“white”, “black”, etc.)

*g:vimroom_min_sidebar_width*
is the minimum sidebar width. This will automatically expand to take up all
the free space left after setting the main workspace window to g:vimroom_width
pcolumns.

*g:vimroom_navigational_keys*
determines whether Vimroom will map keys like <Up>, <Down>, j, and k to
navigate over “display” lines, rather than “logical” lines. This defaults to
p1 (on), if you’d prefer the mapping not take place, set it to 0 (off).

*g:vimroom_scrolloff*
specifies how many lines of text ought appear before and after the cursor.
pThis defaults to 999, which centers the cursor on the screen.

*g:vimroom_sidebar_height*
sets the height of the upper and lower “sidebars.” If you don’t want vertical
padding, set this to 0.

*g:vimroom_width*
is the width of your workspace.


You can bind the <Plug>VimroomToggle function to any key combination you like
via the usual mechanisms. For example::
>
nnoremap <silent> <Leader>mz <Plug>VimroomToggle
<>

Would bind the function to <Leader>mz. Trivial, right?

And that’s it!

==============================================================================
vim:tw=78:ts=2:sw=2:expandtab:ft=help:norl:
Loading

0 comments on commit 6bce69d

Please sign in to comment.