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

various doc fixes

Browse Source
This commit is contained in:
Reed Esau
2013-12-29 01:45:04 -07:00
parent db71640977
commit 86103a7b53
1 changed files with 11 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README.markdown
View File

@@ -3,19 +3,19 @@
> Lightweight auto-correction for Vim > Lightweight auto-correction for Vim
We type `teh` when we meant to type `the`. This plugin is to help us catch We type `teh` when we meant to type `the`. This plugin is to help us catch
the most common of these typos and correct each upon hitting the space the most common of these typos and correct each upon hitting the space bar
bar. (or non-keyword character.)
Features of this plugin: Features of this plugin:
* Focused on the most common of typos that we make * Focused on the most common of typos that we make
* Uses Vim’s `iabbrev` * Uses Vim’s `iabbrev`
* Buffer-scoped * Buffer-scoped behavior
* User-extendable * User-extendable
Note that this plugin is not a replacement for teh spell checker in Vim. Note that this plugin is not a replacement for teh spell checker in Vim.
This plugin defines the most common typos we make along with their corrections: The default typos and their corrections are stored in a global dictionary:
``` ```
let g:litecorrect#defaults = let g:litecorrect#defaults =
@@ -29,8 +29,8 @@ This plugin defines the most common typos we make along with their corrections:
\} \}
``` ```
Note that the corrections are the keys, with the misspellings for each stored Note that the corrections are stored as key-value entries where the value
in a list. is a list of the common misspellings for the key.
## Requirements ## Requirements
@@ -55,7 +55,7 @@ in `markdown` and `textile` files, place in your `.vimrc`:
augroup END augroup END
``` ```
Alternatively, you can build on the defaults by provide your own corrections: Alternatively, you can build on the defaults by providing your own corrections:
``` ```
let user_dict = { let user_dict = {
@@ -66,6 +66,7 @@ Alternatively, you can build on the defaults by provide your own corrections:
augroup litecorrect augroup litecorrect
autocmd! autocmd!
autocmd FileType markdown call litecorrect#init(user_dict) autocmd FileType markdown call litecorrect#init(user_dict)
autocmd FileType textile call litecorrect#init(user_dict)
augroup END augroup END
``` ```
@@ -78,11 +79,13 @@ prevail.
Suggestions for adding to the defaults are welcome, but good evidence is Suggestions for adding to the defaults are welcome, but good evidence is
needed that they are common typos. needed that they are common typos.
## See also ## Related
For a more comprehensive approach, check out For a more comprehensive approach, check out
[vim-autocorrect](https://github.com/panozzaj/vim-autocorrect). [vim-autocorrect](https://github.com/panozzaj/vim-autocorrect).
## See also
If you like this plugin, you may like these other ones from the same author: If you like this plugin, you may like these other ones from the same author:
* [vim-quotable](http://github.com/reedes/vim-quotable) - extends Vim to * [vim-quotable](http://github.com/reedes/vim-quotable) - extends Vim to