MdSpell

Gem Version Build Status Code Climate Test Coverage Inline docs

A Ruby markdown spell checking tool.

Installation

To install from rubygems.org, run:

$ gem install mdspell

On top of that, make sure that GNU Aspell is installed on the system:

# Ubuntu
$ sudo apt-get install aspell
# Arch Linux
$ sudo pacman -S aspell

Usage

To spell-check markdown files, simply run mdspell with the filenames as a parameter:

$ mdspell README.md

To check all markdown files within the directory:

$ mdspell docs/

For each spelling error found, MdSpell will display the misspelled word, filename and line number:

./README.md:10: actualy

MIT Licensed

See LICENSE file for full license text.