This repository has been archived on 2024-10-22. You can view files and clone it, but cannot push or open issues or pull requests.
spacemacs/contrib/spell-checking/README.org

42 lines
1.4 KiB
Org Mode

#+TITLE: Spell Checking configuration layer for Spacemacs
* Table of Contents :TOC@4:
- [[#description][Description]]
- [[#install][Install]]
- [[#layer][Layer]]
- [[#spell-checker-configuration][Spell Checker Configuration]]
- [[#key-bindings][Key Bindings]]
* Description
This layer provides spell checking using [[http://www-sop.inria.fr/members/Manuel.Serrano/flyspell/flyspell.html][Flyspell]].
* Install
** Layer
To use this configuration layer add it to your =~/.spacemacs=
#+BEGIN_SRC emacs-lisp
(setq-default dotspacemacs-configuration-layers '(spell-checking))
#+END_SRC
** Spell Checker Configuration
The built-in Emacs variable that controls which external spell-checking program
is used is =ispell-program-name=, which can be set in your =dotspacemacs/init=
function if you do not like the default. It will give priority to =aspell= if it
is installed on your system. Another important variable to be aware of is
=ispell-dictionary= which will control the default dictionary used by
=ispell-program-name= (instead of using this variable you can also use the key
binding ~SPC S d~).
* Key Bindings
| Key Binding | Description |
|-------------+--------------------------|
| ~SPC S c~ | flyspell correct |
| ~SPC S d~ | change dictionary |
| ~SPC S n~ | flyspell goto next error |
| ~SPC t S~ | toggle flyspell |