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

Misc polishing of text

Browse Source
This commit is contained in:
Reed Esau
2014-01-22 12:09:59 -07:00
parent fd7c0a8b7d
commit 43f48f4e27
1 changed files with 12 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
README.markdown
View File

@@ -21,8 +21,9 @@ smooth the path to writing prose.
* Creates undo points on common punctuation * Creates undo points on common punctuation
* When using hard line breaks, enables autoformat while inserting text * When using hard line breaks, enables autoformat while inserting text
* Buffer-scoped configuration (leaves your global settings alone) * Buffer-scoped configuration (leaves your global settings alone)
* Pure Vimscript with no dependencies
Need spellcheck and other features? Vim is about customization. To Need spell-check and other features? Vim is about customization. To
complete your editing environment, learn to configure Vim and draw upon complete your editing environment, learn to configure Vim and draw upon
its rich ecosystem of plugins. its rich ecosystem of plugins.
@@ -76,6 +77,7 @@ auto-detection figure out what to do. Add to your `.vimrc`:
filetype plugin indent on filetype plugin indent on
let g:pencil#wrapModeDefault = 'hard' " or 'soft' let g:pencil#wrapModeDefault = 'hard' " or 'soft'
augroup pencil augroup pencil
autocmd! autocmd!
autocmd FileType markdown call pencil#init() autocmd FileType markdown call pencil#init()
@@ -97,7 +99,7 @@ to set the behavior for the current buffer:
* `SoftPencil` - mode for soft line wrap * `SoftPencil` - mode for soft line wrap
* `HardPencil` - mode for hard line breaks * `HardPencil` - mode for hard line breaks
* `DropPencil` - removes navigation mappings and restores buffer to global settings * `DropPencil` - removes navigation mappings and restores buffer to global settings
* `TogglePencil` - if off, enables with detection; if on, turns off * `TogglePencil` - if on, turns off; if off, enables with detection
Optionally, you can map to keys in your `.vimrc`: Optionally, you can map to keys in your `.vimrc`:
@@ -110,9 +112,9 @@ nnoremap <silent> <leader>pt :TogglePencil<cr>
### Automatic formatting ### Automatic formatting
_This ‘autoformat’ feature affects **HardPencil** mode only._ _This ‘autoformat’ feature affects *HardPencil* mode only._
When in **HardPencil** mode, Vim’s autoformat feature will be enabled by When in *HardPencil* mode, Vim’s autoformat feature will be enabled by
default in Insert mode and can offer many of the same benefits as soft default in Insert mode and can offer many of the same benefits as soft
line wrap. But autoformat will cause havoc when editing anything but line wrap. But autoformat will cause havoc when editing anything but
paragraphs of words, such as a code block or table. In these cases you paragraphs of words, such as a code block or table. In these cases you
@@ -120,7 +122,7 @@ will need to disable it, at least temporarily, via a command:
* `AutoPencil` - enables autoformat * `AutoPencil` - enables autoformat
* `ManualPencil` - disables autoformat * `ManualPencil` - disables autoformat
* `ShiftPencil` - enables if disabled, etc. * `ShiftPencil` - toggle to enable if disabled, etc.
Or optionally map to keys in your `.vimrc`: Or optionally map to keys in your `.vimrc`:
@@ -219,16 +221,15 @@ At the bottom of this document is a odd-looking code:
<!-- vim: set tw=74 :--> <!-- vim: set tw=74 :-->
``` ```
This is a ‘modeline’ that tells Vim to run the following command upon This is an optional ‘modeline’ that tells Vim to run the following command
loading the file into a buffer: upon loading the file into a buffer:
```vim ```vim
:set textwidth=74 :set textwidth=74
``` ```
This informs _pencil_ that it should assume hard line breaks, regardless It tells _pencil_ to assume hard line breaks, regardless of whether or
of whether or not soft line wrap is the default editing mode for files of not soft line wrap is the default editing mode for files of type ‘markdown’.
type ‘markdown’.
You explicitly specify soft wrap mode by specifying a textwidth of `0`: You explicitly specify soft wrap mode by specifying a textwidth of `0`:
@@ -261,7 +262,7 @@ then _pencil_ assumes soft line wrap.
let g:pencil#softDetectThreshold = 130 let g:pencil#softDetectThreshold = 130
``` ```
If no such lines found, _pencil_ falls back to the default: If no such lines found, _pencil_ falls back to the default mentioned earlier:
```vim ```vim
let g:pencil#wrapModeDefault = 'hard' " or 'soft' let g:pencil#wrapModeDefault = 'hard' " or 'soft'