Run a spell checking job through aspell every time you build with middleman.
Switch branches/tags
Nothing to show
Clone or download
Pull request Compare This branch is 46 commits behind minivan:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
features
fixtures
lib
spec/lib/middleman-spellcheck
.gitignore
.rspec
Gemfile
LICENSE.txt
README.md
Rakefile
middleman-spellcheck.gemspec

README.md

Middleman-Spellchecker

Run a spell checker job after the app is built. Requires 'aspell'.

Installation

Add this line to your application's Gemfile:

gem 'middleman-spellcheck'

And then execute:

$ bundle

Add the following to middleman's config.rb:

activate :spellcheck

Usage

You can spellcheck only some resources using a regex with the URL:

activate :spellcheck, page: "documentation/*" # you can use regexes, too, e.g. /post_[1-9]/

You can limit which tags the spell checker will only run through:

activate :spellcheck, tags: :p  # pass an array of tags if you have more!

If there are some words that you would like to be allowed

activate :spellcheck, allow: ["Gooby", "pls"]

Middleman-spellcheck automatically ignores .css, .js, & .coffee file extensions. If there are some additional file type extensions that you would like to skip:

activate :spellcheck, ignored_exts: [".xml", ".png"]

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Thanks

Special thanks to Readbeard-Tech for the spellchecker gem, which this code is based upon.