Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/junegunn/limelight.vim
:flashlight: All the world's indeed a stage and we are merely players
https://github.com/junegunn/limelight.vim
Last synced: 24 days ago
JSON representation
:flashlight: All the world's indeed a stage and we are merely players
- Host: GitHub
- URL: https://github.com/junegunn/limelight.vim
- Owner: junegunn
- License: mit
- Created: 2014-07-01T16:42:28.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-09-12T09:17:54.000Z (about 2 months ago)
- Last Synced: 2024-09-30T23:40:54.056Z (about 1 month ago)
- Language: Vim Script
- Homepage:
- Size: 31.3 KB
- Stars: 2,359
- Watchers: 14
- Forks: 54
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- my-awesome-github-stars - junegunn/limelight.vim - :flashlight: All the world's indeed a stage and we are merely players (Vim Script)
- awesome-starred-test - junegunn/limelight.vim - :flashlight: All the world's indeed a stage and we are merely players (Vim Script)
- awesome-starred - limelight.vim - :flashlight: All the world's indeed a stage and we are merely players (Vim script)
README
limelight.vim 
=============
Hyperfocus-writing in Vim.
Best served with [Goyo.vim](https://github.com/junegunn/goyo.vim).
Works on 256-color terminal or on GVim.
Installation
------------
Use your favorite plugin manager.
- [vim-plug](https://github.com/junegunn/vim-plug)
1. Add `Plug 'junegunn/limelight.vim'` to your Vim configuration file
2. Run `:source %`
3. Run `:PlugInstall`
Usage
-----
- `Limelight [0.0 ~ 1.0]`
- Turn Limelight on
- `Limelight!`
- Turn Limelight off
- `Limelight!! [0.0 ~ 1.0]`
- Toggle Limelight
### Limelight for a selected range
You can invoke `:Limelight` for a visual range. There are also ``
mappings for normal and visual mode for the purpose.
```vim
nmap l (Limelight)
xmap l (Limelight)
```
### Options
For some color schemes, Limelight may not be able to calculate the color for
dimming down the surrounding paragraphs. In that case, you need to define
`g:limelight_conceal_ctermfg` or `g:limelight_conceal_guifg`.
```vim
" Color name (:help cterm-colors) or ANSI code
let g:limelight_conceal_ctermfg = 'gray'
let g:limelight_conceal_ctermfg = 240
" Color name (:help gui-colors) or RGB color
let g:limelight_conceal_guifg = 'DarkGray'
let g:limelight_conceal_guifg = '#777777'
" Default: 0.5
let g:limelight_default_coefficient = 0.7
" Number of preceding/following paragraphs to include (default: 0)
let g:limelight_paragraph_span = 1
" Beginning/end of paragraph
" When there's no empty line between the paragraphs
" and each paragraph starts with indentation
let g:limelight_bop = '^\s'
let g:limelight_eop = '\ze\n^\s'
" Highlighting priority (default: 10)
" Set it to -1 not to overrule hlsearch
let g:limelight_priority = -1
```
Goyo.vim integration
--------------------
```vim
autocmd! User GoyoEnter Limelight
autocmd! User GoyoLeave Limelight!
```
Acknowledgement
---------------
Thanks to [@Cutuchiqueno](https://github.com/Cutuchiqueno) for [suggesting
the idea](https://github.com/junegunn/goyo.vim/issues/34).
License
-------
MIT