Skip to content

Commit a26cf4e

Browse files
committed
Add documentation for optional mode key bindings
Update block quotes formatting as well.
1 parent 80282c7 commit a26cf4e

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

doc/simple-todo.txt

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,15 @@ https://github.com/blog/1375-task-lists-in-gfm-issues-pulls-comments
3131
Plugin exposes some <Plug> maps. These maps are available for normal, visual
3232
and insert modes.
3333

34-
To completely disable default key bindings (which is pretty handy) use:
34+
All default key bindings (which is pretty handy) can be completely disabled
3535
>
36-
let g:simple_todo_map_keys = 0
36+
let g:simple_todo_map_keys = 0
37+
<
38+
or disabled separately for each mode
39+
>
40+
let g:simple_todo_map_normal_mode_keys = 0
41+
let g:simple_todo_map_insert_mode_keys = 0
42+
let g:simple_todo_map_visual_mode_keys = 0
3743
<
3844
*<Plug>(simple-todo-new)*
3945
<Plug>(simple-todo-new)
@@ -67,15 +73,13 @@ let g:simple_todo_map_keys = 0
6773
3. Customization *simple-todo-customization*
6874

6975
The default tick symbol `x` can be changed by defining:
70-
7176
>
72-
let g:simple_todo_tick_symbol = 'y'
73-
77+
let g:simple_todo_tick_symbol = 'y'
78+
<
7479
You may also change the list symbol `-` by defining:
75-
76-
let g:simple_todo_list_symbol = '*'
80+
>
81+
let g:simple_todo_list_symbol = '*'
7782
<
78-
7983
==============================================================================
8084
4. Contributing *simple-todo-contrib*
8185

0 commit comments

Comments
 (0)