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

Additional tweaks for docs for conceal feature

Browse Source 
Among other overdue simplifications.
This commit is contained in:
Reed Esau
2014-08-25 00:10:51 -06:00
parent 72d617c482
commit 138a1c1dcf
1 changed files with 9 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
README.markdown
View File

@@ -19,8 +19,8 @@ smooth the path to writing prose.
* Agnostic on soft line wrap _versus_ hard line breaks, supporting both * Agnostic on soft line wrap _versus_ hard line breaks, supporting both
* Auto-detects wrap mode via modeline and sampling * Auto-detects wrap mode via modeline and sampling
* Adjusts navigation key mappings to suit the wrap mode * Adjusts navigation key mappings to suit the wrap mode
* Creates undo points on common punctuation during insert, incl. deletion * Creates undo points on common punctuation during insert, including
via line `<C-U>` and word `<C-W>` deletion via line `<C-U>` and word `<C-W>`
* 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)
@@ -118,15 +118,6 @@ to set the behavior for the current buffer:
* `NoPencil` - removes navigation mappings and restores buffer to global settings * `NoPencil` - removes navigation mappings and restores buffer to global settings
* `TogglePencil` - if on, turns off; if off, enables with detection * `TogglePencil` - if on, turns off; if off, enables with detection
Optionally, you can map to keys in your `.vimrc`:
```vim
nnoremap <silent> <leader>ps :SoftPencil<cr>
nnoremap <silent> <leader>ph :HardPencil<cr>
nnoremap <silent> <leader>pn :NoPencil<cr>
nnoremap <silent> <leader>pt :TogglePencil<cr>
```
### Automatic formatting ### Automatic formatting
_This ‘autoformat’ feature affects *HardPencil* mode only._ _This ‘autoformat’ feature affects *HardPencil* mode only._
@@ -141,11 +132,9 @@ will need to disable it, at least temporarily, via a command:
* `ManualPencil` - disables autoformat * `ManualPencil` - disables autoformat
* `ShiftPencil` - toggle to enable if disabled, etc. * `ShiftPencil` - toggle to enable if disabled, etc.
Or optionally map to keys in your `.vimrc`: Or optionally map the toggle to a key in your `.vimrc`:
```vim ```vim
nnoremap <silent> <leader>pa :AutoPencil<cr>
nnoremap <silent> <leader>pm :ManualPencil<cr>
nnoremap <silent> <leader>pp :ShiftPencil<cr> nnoremap <silent> <leader>pp :ShiftPencil<cr>
``` ```
@@ -184,8 +173,6 @@ Optionally, you can map these operations to underutilized keys in your
```vim ```vim
nnoremap <silent> Q gwip nnoremap <silent> Q gwip
nnoremap <silent> K vipJ nnoremap <silent> K vipJ
nnoremap <silent> <leader>Q ggVGgq
nnoremap <silent> <leader>K :%norm vipJ<cr>
``` ```
### Default textwidth ### Default textwidth
@@ -231,14 +218,14 @@ To use Vim’s Conceal feature with Markdown, you will need to install:
1. [tpope/vim-markdown][tm] as it’s currently the only Markdown syntax 1. [tpope/vim-markdown][tm] as it’s currently the only Markdown syntax
plugin that supports conceal. plugin that supports conceal.
2. a font (such as [Cousine][co]) featuring the _italic_, **bold**, 2. a monospaced font (such as [Cousine][co]) featuring the _italic_,
and ***bold italic*** style variants **bold**, and ***bold italic*** style variant for styled text.
3. a colorscheme (such as [reedes/vim-colors-pencil][cp]) which 3. a colorscheme (such as [reedes/vim-colors-pencil][cp]) which supports
supports the Markdown-specific highlight groups. the Markdown-specific highlight groups for styled text.
You should then only see the `_` and `*` markup when in visual or insert You should then only see the `_` and `*` markup for the cursor line and in
mode. The markup will be concealed in normal and command mode. visual selections.
You can change _pencil’s_ default settings for conceal in your `.vimrc`: You can change _pencil’s_ default settings for conceal in your `.vimrc`: