Dist::Zilla::Plugin::JSAN::GitHubDocs - a plugin for Dist::Zilla which updates the 'gh-pages' branch after each release
version 0.06
In your dist.ini:
[JSAN::GitHubDocs] extract = doc/html ; default value redirect_prefix = doc/html ; default value push_to = origin ; default value
After release, this plugin will extract the documentation from the tarball, using the 'extract' parameter to the 'gh-pages' branch of your repo. Then it will push the updates to the "push_to" remote.
The documentation then will be available as
http://your_lowercased_github_user_name.github.com/Your-Dist-Name
The plugin will add the "index.html" file, which redirects the user from the link above to the documentation of the main module (using 'redirect_prefix' parameter):
http://your_lowercased_github_user_name.github.com/Your-Dist-Name/doc/html/Your/Dist/Name.html
Nickolay Platonov <nplatonov@cpan.org>
This software is copyright (c) 2011 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.
To install Dist::Zilla::Plugin::JSAN, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Dist::Zilla::Plugin::JSAN
CPAN shell
perl -MCPAN -e shell install Dist::Zilla::Plugin::JSAN
For more information on module installation, please visit the detailed CPAN module installation guide.