diff options
| author | Florian Fischer <florian.fl.fischer@fau.de> | 2020-08-26 17:00:51 +0200 |
|---|---|---|
| committer | Florian Fischer <florian.fl.fischer@fau.de> | 2020-08-26 17:02:22 +0200 |
| commit | 70128494d0c60a8096cea856a536ce69ed05ed77 (patch) | |
| tree | 6d2c28ec2c888a198b2067755fc9098d0717ef53 /Readme.md | |
| parent | e5bceacb31238b2580321bc5afb7607764820fb4 (diff) | |
| download | vis-spellcheck-70128494d0c60a8096cea856a536ce69ed05ed77.tar.gz | |
update Readme to mention <F7> and th check_tokens variable
Diffstat (limited to 'Readme.md')
| -rw-r--r-- | Readme.md | 5 |
1 files changed, 4 insertions, 1 deletions
@@ -11,6 +11,7 @@ A spellchecking lua plugin for the [vis editor](https://github.com/martanne/vis) + To enable highlighting of misspelled words press `<Ctrl-w>e` in normal mode. + To disable highlighting press `<Ctrl-w>d` in normal mode. ++ To toggle highlighting press `<F7>` in normal mode. + To correct the word under the cursor press `<Ctrl+w>w` in normal mode. + To ignore the word under the cursor press `<Ctrl+w>i` in normal mode. @@ -24,8 +25,10 @@ The module table returned from `require(...)` has some configuration options: * default: `enchant -l -d %s` * `lang`: The name of the used dictionary. `lang` is inserted in the cmd-strings at `%s`. * default: `$LANG` or `en_US` -* `typo_style`: The style string with which misspellings should be highlighted +* `typo_style`: The style string with which misspellings should be highlighted when using the _full viewport_ method * default: `fore:red` +* `check_tokens`: A table mapping all token names we consider for spellchecking to true + * default: `{[vis.lexers.STRING]=true, [vis.lexers.COMMENT]=true}` A possible configuration could look like this: |