MdSpell
¶ ↑
[
]( travis-ci.org/mtuchowski/mdspell) [
]( codeclimate.com/github/mtuchowski/mdspell) [
]( codeclimate.com/github/mtuchowski/mdspell/coverage) [
]( inch-ci.org/github/mtuchowski/mdspell) [
]( gemnasium.com/mtuchowski/mdspell)
A Ruby markdown spell checking tool.
Installation¶ ↑
To install from rubygems.org, run:
$ gem install mdspell Successfully installed mdspell-0.1.3 1 gem installed
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 filename (or directory) as a parameter. For each spelling error found, MdSpell
will display the misspelled word, filename and line number:
$ mdspell README.md spec README.md:19: MD014 Dollar signs used before commands without showing output README.md:36: MD014 Dollar signs used before commands without showing output README.md:42: MD014 Dollar signs used before commands without showing output spec/examples/with_errors.md:1: mispelled spec/examples/with_errors.md:3: qiute spec/examples/with_errors.md:3: actualy spec/examples/with_errors.md:5: tobe spec/examples/complete.md:24: Unordered
Ignore lists¶ ↑
In some cases, there may be words that are legitimately not in the dictionary you are using because they are proper nouns, or obscure technical terms.
You may specify words (or even regular expressions) to ignore via the –ignored flag:
mdspell README.md --ignored config,mdspell,ruby.*,file.ame
Likewise, you may specify this in a config file
ignored: - expr1 - word2 ...
Please note that you should take care to use non-greedy, precise, regular expressions as to not mask legitimate spelling errors.
MIT Licensed¶ ↑
See LICENSE file for full license text.