README

= jekyll-testtasks - Test your Jekyll plugins with ease.

== VERSION

This documentation refers to jekyll-testtasks version 0.0.2


== DESCRIPTION

Simplifies testing your Jekyll plugins. Just add this to your Rakefile:

  require 'jekyll/testtasks/rake'

Currently only allows to run Jekyll's original test tasks with your plugin
loaded to make sure you didn't break anything. More to come?

Note that your Jekyll installation needs to be patched in order to run with
your plugin loaded. The necessary patch will be displayed when you try to
run a task against an unpatched installation.

You can point at the Jekyll installation to use by either setting the
environment variable +JEKYLL+ or by creating a file <tt>.jekyll</tt> in
your plugin's project directory with the path in it.


== LINKS

Documentation:: https://blackwinter.github.io/jekyll-testtasks/
Source code::   https://github.com/blackwinter/jekyll-testtasks
RubyGem::       https://rubygems.org/gems/jekyll-testtasks


== AUTHORS

* Jens Wille <mailto:jens.wille@gmail.com>


== LICENSE AND COPYRIGHT

Copyright (C) 2010-2011 University of Cologne,
Albertus-Magnus-Platz, 50923 Cologne, Germany

Copyright (C) 2013 Jens Wille

jekyll-testtasks is free software: you can redistribute it and/or modify it
under the terms of the GNU Affero General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your option)
any later version.

jekyll-testtasks is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
details.

You should have received a copy of the GNU Affero General Public License along
with jekyll-testtasks. If not, see <http://www.gnu.org/licenses/>.