m-vim_plugins/vim-pencil
1
0
Fork 0
mirror of https://github.com/preservim/vim-pencil.git synced 2025-11-14 04:43:47 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

rewrite of feature list

Browse Source
This commit is contained in:
Reed Esau
2014-01-05 12:36:36 -07:00
parent 464cae3019
commit e7a1ced986
1 changed files with 10 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
README.markdown
View File

@@ -4,10 +4,11 @@
Features of this plugin: Features of this plugin:
* Configures Vim for word processing, with key mappings, undo points, etc. * Sets up buffer for word processing
* Agnostic on hard line endings _versus_ soft wrapping
* Use for editing markdown, textile, documentation, etc. * Use for editing markdown, textile, documentation, etc.
* Can detect wrapping approach via modeline * Configures wrap mode, auto-detecting from modeline if present
* Adjusts navigation key mappings to suit the wrap mode
* Creates undo points on common punctuation
Why such a minimalistic approach? There are several Vim plugins for Why such a minimalistic approach? There are several Vim plugins for
writing that take a comprehensive approach, including changing not only writing that take a comprehensive approach, including changing not only
@@ -56,14 +57,12 @@ plugin.)
## Configuration ## Configuration
### Hard breaks or soft wrapping? ### Hard line breaks or soft line wrapping?
Where do you stand on hard line breaks versus soft line wrapping? Coders will have the most experience with the former, and writers the
latter. But whatever your background, chances are that you will be living
Typically, coders will have the most experience with the former, and in a mixed environment where you must contend with both. This plugin
writers the latter. But whatever your background, chances are that you doesn't force you to choose a side—each buffer is configured
will be living in a mixed environment where you must contend with both.
This plugin doesn't force you to choose a side—each buffer is configured
independently. independently.
In most cases you can set a default to suit your preference and let In most cases you can set a default to suit your preference and let
@@ -116,7 +115,7 @@ let g:pencil#textwidth = 74
`joinspaces` determines number of spaces after period (`0`=1 space, `1`=2 spaces) `joinspaces` determines number of spaces after period (`0`=1 space, `1`=2 spaces)
```vim ```vim
let g:pencil#joinspaces=0 let g:pencil#joinspaces = 0
``` ```
## Automatic formatting ## Automatic formatting