Update goyo.vim and vim-zenroom2.
This commit is contained in:
Kurtis Moxley
parent
3d5fd32152
commit
d85f7ef8df
|
|
@ -0,0 +1,6 @@
|
|||
.gitattributes export-ignore
|
||||
.gitignore export-ignore
|
||||
doc/tags export-ignore
|
||||
*.md export-ignore
|
||||
zip export-ignore
|
||||
test/* export-ignore
|
||||
|
|
@ -0,0 +1 @@
|
|||
doc/tags
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2013-2021 Junegunn Choi
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
|
|
@ -0,0 +1,134 @@
|
|||
goyo.vim ([고요](http://en.wiktionary.org/wiki/고요하다))
|
||||
=========================================================
|
||||
|
||||
Distraction-free writing in Vim.
|
||||
|
||||
|
||||
|
||||
(Color scheme: [seoul256](https://github.com/junegunn/seoul256.vim))
|
||||
|
||||
Best served with [limelight.vim](https://github.com/junegunn/limelight.vim).
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
||||
Use your favorite plugin manager.
|
||||
|
||||
- [vim-plug](https://github.com/junegunn/vim-plug)
|
||||
1. Add `Plug 'junegunn/goyo.vim'` to .vimrc
|
||||
2. Run `:PlugInstall`
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
- `:Goyo`
|
||||
- Toggle Goyo
|
||||
- `:Goyo [dimension]`
|
||||
- Turn on or resize Goyo
|
||||
- `:Goyo!`
|
||||
- Turn Goyo off
|
||||
|
||||
The window can be resized with the usual `[count]<CTRL-W>` + `>`, `<`, `+`,
|
||||
`-` keys, and `<CTRL-W>` + `=` will resize it back to the initial size.
|
||||
|
||||
### Dimension expression
|
||||
|
||||
The expected format of a dimension expression is
|
||||
`[WIDTH][XOFFSET][x[HEIGHT][YOFFSET]]`. `XOFFSET` and `YOFFSET` should be
|
||||
prefixed by `+` or `-`. Each component can be given in percentage.
|
||||
|
||||
```vim
|
||||
" Width
|
||||
Goyo 120
|
||||
|
||||
" Height
|
||||
Goyo x30
|
||||
|
||||
" Both
|
||||
Goyo 120x30
|
||||
|
||||
" In percentage
|
||||
Goyo 120x50%
|
||||
|
||||
" With offsets
|
||||
Goyo 50%+25%x50%-25%
|
||||
```
|
||||
|
||||
Configuration
|
||||
-------------
|
||||
|
||||
- `g:goyo_width` (default: 80)
|
||||
- `g:goyo_height` (default: 85%)
|
||||
- `g:goyo_linenr` (default: 0)
|
||||
|
||||
### Callbacks
|
||||
|
||||
By default, [vim-airline](https://github.com/bling/vim-airline),
|
||||
[vim-powerline](https://github.com/Lokaltog/vim-powerline),
|
||||
[powerline](https://github.com/Lokaltog/powerline),
|
||||
[lightline.vim](https://github.com/itchyny/lightline.vim),
|
||||
[vim-signify](https://github.com/mhinz/vim-signify),
|
||||
and [vim-gitgutter](https://github.com/airblade/vim-gitgutter) are temporarily
|
||||
disabled while in Goyo mode.
|
||||
|
||||
If you have other plugins that you want to disable/enable, or if you want to
|
||||
change the default settings of Goyo window, you can set up custom routines
|
||||
to be triggered on `GoyoEnter` and `GoyoLeave` events.
|
||||
|
||||
```vim
|
||||
function! s:goyo_enter()
|
||||
if executable('tmux') && strlen($TMUX)
|
||||
silent !tmux set status off
|
||||
silent !tmux list-panes -F '\#F' | grep -q Z || tmux resize-pane -Z
|
||||
endif
|
||||
set noshowmode
|
||||
set noshowcmd
|
||||
set scrolloff=999
|
||||
Limelight
|
||||
" ...
|
||||
endfunction
|
||||
|
||||
function! s:goyo_leave()
|
||||
if executable('tmux') && strlen($TMUX)
|
||||
silent !tmux set status on
|
||||
silent !tmux list-panes -F '\#F' | grep -q Z && tmux resize-pane -Z
|
||||
endif
|
||||
set showmode
|
||||
set showcmd
|
||||
set scrolloff=5
|
||||
Limelight!
|
||||
" ...
|
||||
endfunction
|
||||
|
||||
autocmd! User GoyoEnter nested call <SID>goyo_enter()
|
||||
autocmd! User GoyoLeave nested call <SID>goyo_leave()
|
||||
```
|
||||
|
||||
More examples can be found here:
|
||||
[Customization](https://github.com/junegunn/goyo.vim/wiki/Customization)
|
||||
|
||||
Inspiration
|
||||
-----------
|
||||
|
||||
- [LiteDFM](https://github.com/bilalq/lite-dfm)
|
||||
- [VimRoom](http://projects.mikewest.org/vimroom/)
|
||||
|
||||
Pros.
|
||||
-----
|
||||
|
||||
1. Works well with splits. Doesn't mess up with the current window arrangement
|
||||
1. Works well with popular statusline plugins
|
||||
1. Prevents accessing the empty windows around the central buffer
|
||||
1. Can be closed with any of `:q[uit]`, `:clo[se]`, `:tabc[lose]`, or `:Goyo`
|
||||
1. Can dynamically change the width of the window
|
||||
1. Adjusts its colors when color scheme is changed
|
||||
1. Realigns the window when the terminal (or window) is resized or when the size
|
||||
of the font is changed
|
||||
1. Correctly hides colorcolumns and Emojis in statusline
|
||||
1. Highly customizable with callbacks
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
MIT
|
||||
|
||||
Loading…
Reference in New Issue