doomemacs/modules/checkers/grammar/README.org

:checkers grammar

• Description
  • Maintainers
  • Module flags
  • Packages
  • Hacks
  • Changelog
• Installation
• Usage
  • Language Tool
    • Commands
  • writegood-mode
• Configuration
• Troubleshooting
• Frequently asked questions
• Appendix

Description   unfold

This module adds grammar checking to Emacs to aid your writing by combining doom-package:lang-tool and doom-package:writegood-mode.

Maintainers

This module has no dedicated maintainers. Become a maintainer?

Module flags

This module has no flags.

Packages

• doom-package:langtool
• doom-package:writegood-mode

Hacks

No hacks documented for this module.

TODO Changelog

This module does not have a changelog yet.

Installation

Enable this module in your doom! block.

This module requires LanguageTool (which requires Java 1.8+).

It is available from either https://languagetool.org/ or your OS's package manager. E.g.

• macOS: $ brew install languagetool
• Arch Linux: $ pacman -S languagetool
• NixOS: nixpkgs.languagetool

This module tries to guess the location of languagetool-commandline.jar. If you get a warning that Doom couldn't find languagetool-commandline.jar, you will need to set langtool-language-tool-jar to its location.

TODO Usage

󱌣 This module's usage documentation is incomplete. Complete it?

Language Tool

Language Tool is a polyglot proofreader service that checks for grammar and stylistic issues in your writing. This requires Java 1.8+.

 This requires Java 1.8+

Commands

• M-x langtool-check
• M-x langtool-correct-buffer

writegood-mode

This minor mode highlights weasel words, duplication and passive voice.

TODO Configuration

󱌣 This module has no configuration documentation yet. Write some?

Troubleshooting

There are no known problems with this module. Report one?

Frequently asked questions

This module has no FAQs yet. Ask one?

TODO Appendix

󱌣 This module has no appendix yet. Write one?