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

whichwrap, autoindent, fo, reorg of README

Browse Source
This commit is contained in:
Reed Esau
2014-01-07 21:08:06 -07:00
parent 3d267d2e8d a0e27fd503
commit 1db70ca646
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.markdown
View File

@@ -1,18 +1,18 @@
# vim-pencil # vim-pencil
> Because Vim can be great for writing prose and documentation - - -
![demo](screenshots/demo.gif) ![demo](screenshots/demo.gif)
- - -
# Features # Features
This plugin focus on the basics: This plugin focuses on the fundamentals of word processing in Vim:
* Configures a buffer for word processing * Configures a buffer for word processing
* Use for editing markdown, textile, documentation, etc. * Use for editing markdown, textile, documentation, etc.
* Configures wrap mode, auto-detecting from modeline if present * Configures wrap mode for buffer, auto-detecting via modeline if present
* Adjusts navigation key mappings to suit the wrap mode * Adjusts navigation key mappings to suit the wrap mode
* For hard line breaks, enables Insert-mode only autoformat * For hard line break mode, enables Insert-mode only autoformat
* Creates undo points on common punctuation * 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
@@ -92,7 +92,7 @@ to set the behavior for the current buffer:
* `SoftPencil` - configure for the soft wrapping of very long lines * `SoftPencil` - configure for the soft wrapping of very long lines
* `HardPencil` - configure for line endings with hard line breaks * `HardPencil` - configure for line endings with hard line breaks
* `TogglePencil` - if off, enables with detection; if on, turns off * `TogglePencil` - if off, enables with detection; if on, turns off
* `NoPencil` - removing mappings and restore global settings * `NoPencil` - removes navigation mappings and restores buffer to global settings
Optionally, you can map to keys in your `.vimrc`: Optionally, you can map to keys in your `.vimrc`:
@@ -210,7 +210,7 @@ That’s a strong hint to this plugin that we should assume hard line
endings, regardless of whether or not soft wrapping is the default editing endings, regardless of whether or not soft wrapping is the default editing
mode for files of type ‘markdown’. mode for files of type ‘markdown’.
If it’s 0, then soft line wrapping is assumed. If it’s 0, then pencil assumes you want soft line wrapping.
``` ```
<!-- vim: set tw=0 :--> <!-- vim: set tw=0 :-->