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

minor rewording and formatting

Browse Source
This commit is contained in:
Reed Esau
2015-01-28 23:36:58 -07:00
parent 91dc000fb1
commit 96546d4b17
1 changed files with 19 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
README.markdown
View File

@@ -143,8 +143,8 @@ git clone https://github.com/reedes/vim-pencil
## Basic initialization ## Basic initialization
Though optional, initializing _pencil_ by `FileType` will automatically Initializing _pencil_ by `FileType` is optional, though doing so will
set up your buffers for editing prose. automatically set up your buffers for editing prose.
Add support for your desired filetypes to your `.vimrc`: Add support for your desired filetypes to your `.vimrc`:
@@ -226,9 +226,9 @@ When inserting text while in *PencilHard* mode, Vim’s autoformat feature
will be enabled by default and can offer many of the same benefits as will be enabled by default and can offer many of the same benefits as
soft line wrap. soft line wrap.
One useful exception (aka 'blacklisting'): if used with popular One useful exception (aka 'blacklisting'): if used with popular
prose-oriented syntax plugins, _pencil_ will **not** enable autoformat when prose-oriented syntax plugins, _pencil_ will **not** enable autoformat when
you enter Insert mode from inside a code block or table. (See the you enter Insert mode from inside a code block or table. (See the
advanced section below for more details on the blacklisting feature.) advanced section below for more details on the blacklisting feature.)
Where you need to manually enable/disable autoformat for the current Where you need to manually enable/disable autoformat for the current
@@ -391,20 +391,20 @@ You can override _pencil_ and other configuration settings when initializing:
```vim ```vim
augroup pencil augroup pencil
autocmd! autocmd!
autocmd FileType markdown,mkd call pencil#init() | autocmd FileType markdown,mkd call pencil#init()
\ call litecorrect#init() | \ | call litecorrect#init()
\ setl spell spl=en_us fdl=4 noru nonu nornu | \ | setl spell spl=en_us fdl=4 noru nonu nornu
\ setl fdo+=search \ | setl fdo+=search
autocmd Filetype git,gitsendemail,*commit*,*COMMIT* | autocmd Filetype git,gitsendemail,*commit*,*COMMIT*
\ call pencil#init({'wrap': 'hard', 'textwidth': 72}) | \ call pencil#init({'wrap': 'hard', 'textwidth': 72})
\ call litecorrect#init() | \ | call litecorrect#init()
\ setl spell spl=en_us et sw=2 ts=2 noai \ | setl spell spl=en_us et sw=2 ts=2 noai
autocmd Filetype mail call pencil#init({'wrap': 'hard', 'textwidth': 60}) | autocmd Filetype mail call pencil#init({'wrap': 'hard', 'textwidth': 60})
\ call litecorrect#init() | \ | call litecorrect#init()
\ setl spell spl=en_us et sw=2 ts=2 noai nonu nornu \ | setl spell spl=en_us et sw=2 ts=2 noai nonu nornu
autocmd Filetype html,xml call pencil#init({'wrap': 'soft'}) | autocmd Filetype html,xml call pencil#init({'wrap': 'soft'})
\ call litecorrect#init() | \ | call litecorrect#init()
\ setl spell spl=en_us et sw=2 ts=2 \ | setl spell spl=en_us et sw=2 ts=2
augroup END augroup END
``` ```