NAME

Dist::Zilla::Plugin::JSAN::GitHubDocs - a plugin for Dist::Zilla which updates the 'gh-pages' branch after each release

VERSION

version 0.03

SYNOPSIS

In your dist.ini:

[JSAN::GitHubDocs]
extract             = doc/html          ; default value
redirect_prefix     = doc/html          ; default value
push_to             = origin            ; default value

DESCRIPTION

After each release, this plugin will extract the documentation directory from the tarball (defined by the 'extract' argument) to the 'gh-pages' branch and push it to the "push_to" remote. It will also add an "index.html" file, which simple redirects the user to the documentation file of the main module (using "redirect_prefix" parameter).

AUTHOR

Nickolay Platonov <nplatonov@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2010 by Nickolay Platonov.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.