From 70128494d0c60a8096cea856a536ce69ed05ed77 Mon Sep 17 00:00:00 2001 From: Florian Fischer Date: Wed, 26 Aug 2020 17:00:51 +0200 Subject: update Readme to mention and th check_tokens variable --- Readme.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'Readme.md') diff --git a/Readme.md b/Readme.md index 87f27ec..2f41b91 100644 --- a/Readme.md +++ b/Readme.md @@ -11,6 +11,7 @@ A spellchecking lua plugin for the [vis editor](https://github.com/martanne/vis) + To enable highlighting of misspelled words press `e` in normal mode. + To disable highlighting press `d` in normal mode. ++ To toggle highlighting press `` in normal mode. + To correct the word under the cursor press `w` in normal mode. + To ignore the word under the cursor press `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: -- cgit v1.2.3 From ebdd1360935b8c27eae6929042b0386af3e2e43b Mon Sep 17 00:00:00 2001 From: Florian Fischer Date: Wed, 26 Aug 2020 19:11:14 +0200 Subject: add the option 'disable_syntax_awareness' to always check the full viewport --- Readme.md | 2 ++ 1 file changed, 2 insertions(+) (limited to 'Readme.md') diff --git a/Readme.md b/Readme.md index 2f41b91..dd18c64 100644 --- a/Readme.md +++ b/Readme.md @@ -29,6 +29,8 @@ The module table returned from `require(...)` has some configuration options: * 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}` +* `disable_syntax_awareness`: Disable the syntax aware spellchecking and use always _full viewport_ + * default: `false` A possible configuration could look like this: -- cgit v1.2.3 From ca3342d1cb7e16501960f4f83b35f3778ec1d6cd Mon Sep 17 00:00:00 2001 From: Florian Fischer Date: Thu, 17 Sep 2020 11:29:43 +0200 Subject: mention vis.lexers.DEFAULT in Readme and capitalize headlines --- Readme.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'Readme.md') diff --git a/Readme.md b/Readme.md index dd18c64..31a06fd 100644 --- a/Readme.md +++ b/Readme.md @@ -2,12 +2,12 @@ A spellchecking lua plugin for the [vis editor](https://github.com/martanne/vis). -## installation +## Installation 1. Download `spellcheck.lua` or clone this repository 2. Load the plugin in your `visrc.lua` with `require(path/to/plugin/spellcheck)` -## usage +## Usage + To enable highlighting of misspelled words press `e` in normal mode. + To disable highlighting press `d` in normal mode. @@ -15,7 +15,7 @@ A spellchecking lua plugin for the [vis editor](https://github.com/martanne/vis) + To correct the word under the cursor press `w` in normal mode. + To ignore the word under the cursor press `i` in normal mode. -## configuration +## Configuration The module table returned from `require(...)` has some configuration options: @@ -28,7 +28,7 @@ The module table returned from `require(...)` has some configuration options: * `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}` + * default: `{[vis.lexers.STRING]=true, [vis.lexers.COMMENT]=true, [vis.lexers.DEFAULT]=true}` * `disable_syntax_awareness`: Disable the syntax aware spellchecking and use always _full viewport_ * default: `false` -- cgit v1.2.3