aboutsummaryrefslogtreecommitdiffstats
path: root/Readme.md
blob: 82db43d58e155e8c2602505da510c1ca7a8ecbe7 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
# vis-spellcheck

A spellchecking lua plugin for the [vis editor](https://github.com/martanne/vis).

## installation

1. Download `spellcheck.lua` or clone this repository
2. Load the plugin in your `visrc.lua` with `require(path/to/plugin/spellcheck)`

## usage

+ To correct the whole file press Ctrl+s in normal mode.

## configuration

The module table returned from `require(...)` has two configuration fields
`lang` and `cmd`. `lang` is inserted in the `cmd` string at `%s`.
The defaults are `enchant -d %s` and `$LANG or "en_US".

	spell = require(...)
	spell.cmd = "aspell -l %s -a"
	spell.lang = "en_US"