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

Misc improvements

Browse Source
This commit is contained in:
Reed Esau
2014-08-27 01:26:08 -06:00
parent 05f1296551
commit 82d39c442d
1 changed files with 16 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
README.markdown
View File

@@ -23,9 +23,9 @@ smooth the path to writing prose.
* When using hard line breaks, enables autoformat while inserting text * When using hard line breaks, enables autoformat while inserting text
* Buffer-scoped configuration (with a few minor exceptions, _pencil_ * Buffer-scoped configuration (with a few minor exceptions, _pencil_
preserves your global settings) preserves your global settings)
* Pure Vimscript with no dependencies
* Support for Vim’s Conceal feature to hide markup defined by Syntax * Support for Vim’s Conceal feature to hide markup defined by Syntax
plugins (e.g., `_` and `*` markup for styled text in \_*Markdown\_*) plugins (e.g., `_` and `*` markup for styled text in \_*Markdown\_*)
* Pure Vimscript with no dependencies
Need spell-check 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
@@ -119,15 +119,15 @@ to set the behavior for the current buffer:
### Automatic formatting ### Automatic formatting
_This ‘autoformat’ feature affects *HardPencil* mode only._ _This ‘autoformat’ feature affects *HardPencil* (hard line break) mode only._
When you are inserting text in *HardPencil* mode, Vim’s autoformat feature When inserting text while in *HardPencil* mode, Vim’s autoformat feature will be
will be enabled by default and can offer many of the same benefits as soft enabled by default and can offer many of the same benefits as soft line wrap.
line wrap.
If used with popular syntax modules\*, _pencil_ will disable autoformat when An exception: if used with popular syntax modules\*, _pencil_ will **disable**
you enter Insert mode from inside a code block. In other cases where you autoformat when you enter Insert mode from inside a code block.
need to disable autoformat, you can do so with a command:
Where you need to manually enable/disable autoformat, you can do so with a command:
* `AutoPencil` - enables autoformat * `AutoPencil` - enables autoformat
* `ManualPencil` - disables autoformat * `ManualPencil` - disables autoformat
@@ -192,9 +192,9 @@ let g:pencil#textwidth = 74
### Sentence spacing ### Sentence spacing
By default, when formatting only one space will be inserted after By default, when formatting text (through `gwip`, e.g.) only one space
a period(`.`), exclamation point(`!`), or question mark(`?`). You can will be inserted after a period(`.`), exclamation point(`!`), or question
change this default: mark(`?`). You can change this default:
```vim ```vim
let g:pencil#joinspaces = 0 " 0=one_space (def), 1=two_spaces let g:pencil#joinspaces = 0 " 0=one_space (def), 1=two_spaces
@@ -219,8 +219,8 @@ Syntax and Colorscheme plugins is currently spotty.
You can change _pencil’s_ default settings for conceal in your `.vimrc`: You can change _pencil’s_ default settings for conceal in your `.vimrc`:
```vim ```vim
let g:pencil#conceallevel = 3 " 0=disable, 1=onechar, 2=hidechar, 3=hideall let g:pencil#conceallevel = 3 " 0=disable, 1=onechar, 2=hidechar, 3=hideall (def)
let g:pencil#concealcursor = 'c' " n=normal, v=visual, i=insert, c=command let g:pencil#concealcursor = 'c' " n=normal, v=visual, i=insert, c=command (def)
``` ```
For more details on Vim’s Conceal feature, see: For more details on Vim’s Conceal feature, see:
@@ -250,7 +250,7 @@ To use Vim’s Conceal feature with Markdown, you will need to install:
You should then only see the `_` and `*` markup for the cursor line and in You should then only see the `_` and `*` markup for the cursor line and in
visual selections. visual selections.
Terminal users: consult your terminal’s documentation to configure your **Terminal users:** consult your terminal’s documentation to configure your
terminal to support **bold** and _italic_ styles. terminal to support **bold** and _italic_ styles.
[co]: http://www.google.com/fonts/specimen/Cousine [co]: http://www.google.com/fonts/specimen/Cousine
@@ -258,6 +258,8 @@ terminal to support **bold** and _italic_ styles.
## Auto-detecting wrap mode ## Auto-detecting wrap mode
(For advanced users looking to tweak _pencil's_ behavior.)
If you didn't explicitly specify a wrap mode during initialization, If you didn't explicitly specify a wrap mode during initialization,
_pencil_ will attempt to detect it. _pencil_ will attempt to detect it.