From 138a1c1dcfb7a2acb4f816deec42b3e232e3bf6d Mon Sep 17 00:00:00 2001 From: Reed Esau Date: Mon, 25 Aug 2014 00:10:51 -0600 Subject: [PATCH] Additional tweaks for docs for conceal feature Among other overdue simplifications. --- README.markdown | 31 +++++++++---------------------- 1 file changed, 9 insertions(+), 22 deletions(-) diff --git a/README.markdown b/README.markdown index 045d71a..297ab48 100644 --- a/README.markdown +++ b/README.markdown @@ -19,8 +19,8 @@ smooth the path to writing prose. * Agnostic on soft line wrap _versus_ hard line breaks, supporting both * Auto-detects wrap mode via modeline and sampling * Adjusts navigation key mappings to suit the wrap mode -* Creates undo points on common punctuation during insert, incl. deletion - via line `` and word `` +* Creates undo points on common punctuation during insert, including + deletion via line `` and word `` * When using hard line breaks, enables autoformat while inserting text * Buffer-scoped configuration (with a few minor exceptions, _pencil_ 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 * `TogglePencil` - if on, turns off; if off, enables with detection -Optionally, you can map to keys in your `.vimrc`: - -```vim -nnoremap ps :SoftPencil -nnoremap ph :HardPencil -nnoremap pn :NoPencil -nnoremap pt :TogglePencil -``` - ### Automatic formatting _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 * `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 -nnoremap pa :AutoPencil -nnoremap pm :ManualPencil nnoremap pp :ShiftPencil ``` @@ -184,8 +173,6 @@ Optionally, you can map these operations to underutilized keys in your ```vim nnoremap Q gwip nnoremap K vipJ -nnoremap Q ggVGgq -nnoremap K :%norm vipJ ``` ### 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 plugin that supports conceal. -2. a font (such as [Cousine][co]) featuring the _italic_, **bold**, - and ***bold italic*** style variants +2. a monospaced font (such as [Cousine][co]) featuring the _italic_, + **bold**, and ***bold italic*** style variant for styled text. -3. a colorscheme (such as [reedes/vim-colors-pencil][cp]) which - supports the Markdown-specific highlight groups. +3. a colorscheme (such as [reedes/vim-colors-pencil][cp]) which supports + the Markdown-specific highlight groups for styled text. -You should then only see the `_` and `*` markup when in visual or insert -mode. The markup will be concealed in normal and command mode. +You should then only see the `_` and `*` markup for the cursor line and in +visual selections. You can change _pencil’s_ default settings for conceal in your `.vimrc`: