doc: update docs
This commit is contained in:
parent
e3b5bdd392
commit
2970edd2ab
2 changed files with 17 additions and 3 deletions
12
README.md
12
README.md
|
|
@ -1,6 +1,6 @@
|
||||||
# vim-singlechar
|
# vim-singlechar
|
||||||
|
|
||||||
A simple Vim plugin that lets you insert single characters without leaving normal mode.
|
A simple Vim plugin that lets you insert single characters (including Unicode) without leaving normal mode.
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
|
|
@ -8,8 +8,9 @@ A simple Vim plugin that lets you insert single characters without leaving norma
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- Insert characters at or after the cursor position
|
- Insert characters (supports Unicode) at or after the cursor position
|
||||||
- Support for counts to insert a character multiple times
|
- Support for counts to insert a character multiple times
|
||||||
|
- Input validation: warns if more than one character is entered
|
||||||
- Stay in normal mode for efficient editing
|
- Stay in normal mode for efficient editing
|
||||||
- Minimal workflow interruption
|
- Minimal workflow interruption
|
||||||
- Works with Vim 9+
|
- Works with Vim 9+
|
||||||
|
|
@ -71,6 +72,13 @@ let g:singlechar_prompt = 'Press the character to insert - Press Esc to cancel..
|
||||||
|
|
||||||
" Disable default mappings (if you want to create your own)
|
" Disable default mappings (if you want to create your own)
|
||||||
let g:singlechar_no_mappings = 1
|
let g:singlechar_no_mappings = 1
|
||||||
|
|
||||||
|
" Show warning if more than one character is entered (default: enabled)
|
||||||
|
let g:singlechar_keylen_warning = 1
|
||||||
|
|
||||||
|
" Customize the warning message (default: 'Only the first character will be taken: {char}')
|
||||||
|
let g:singlechar_warning_message = 'Only the first character will be taken: {char}'
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Commands
|
## Commands
|
||||||
|
|
|
||||||
|
|
@ -27,7 +27,7 @@ INTRODUCTION *singlechar-introducti
|
||||||
vim-singlechar is a minimalist Vim plugin designed to optimize the workflow of
|
vim-singlechar is a minimalist Vim plugin designed to optimize the workflow of
|
||||||
inserting single characters during editing. It eliminates the need to enter insert
|
inserting single characters during editing. It eliminates the need to enter insert
|
||||||
mode for simple edits like adding punctuation, which helps maintain the flow of
|
mode for simple edits like adding punctuation, which helps maintain the flow of
|
||||||
normal mode operations.
|
normal mode operations. Now supports Unicode.
|
||||||
|
|
||||||
===============================================================================
|
===============================================================================
|
||||||
REQUIREMENTS *singlechar-requirements*
|
REQUIREMENTS *singlechar-requirements*
|
||||||
|
|
@ -111,6 +111,12 @@ Disabling default mappings: >
|
||||||
Changing the prompt message: >
|
Changing the prompt message: >
|
||||||
let g:singlechar_prompt = 'Character to insert (Esc to cancel): '
|
let g:singlechar_prompt = 'Character to insert (Esc to cancel): '
|
||||||
<
|
<
|
||||||
|
Show warning if more than one character is entered (default: enabled): >
|
||||||
|
let g:singlechar_keylen_warning = 1
|
||||||
|
<
|
||||||
|
Customize the warning message (default: 'Only the first character will be taken: {char}'): >
|
||||||
|
let g:singlechar_warning_message = 'Only the first character will be taken: {char}'
|
||||||
|
<
|
||||||
===============================================================================
|
===============================================================================
|
||||||
EXAMPLES *singlechar-examples*
|
EXAMPLES *singlechar-examples*
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue