• NAME
• VERSION
• SYNOPSIS
• DESCRIPTION
• ATTRIBUTES
  • fatal
  • ignore
• METHODS
  • check_pages
  • register
• AUTHOR
• COPYRIGHT AND LICENSE

NAME

Statocles::Plugin::LinkCheck - Check links and images for validity during build

VERSION

version 0.096

SYNOPSIS

    # site.yml
    site:
        class: Statocles::Site
        args:
            plugins:
                link_check:
                    $class: Statocles::Plugin::LinkCheck

DESCRIPTION

This plugin checks all of the links and images to ensure they exist. If something is missing, this plugin will write a warning to the screen. If fatal is set to true, it will also call die() afterwards.

ATTRIBUTES

fatal

If set to true, and there are any broken links, the plugin will also call die() after printing the problems. Defaults to false.

ignore

An array of URL patterns to ignore. These are interpreted as regular expressions, and are anchored to the beginning of the URL.

For example:

    /broken     will match "/broken.html" "/broken/page.html" but not "/page/broken"
    .*/broken   will match "/broken.html" "/broken/page.html" and "/page/broken"

METHODS

check_pages

    $plugin->check_pages( $event );

Check the pages inside the given Statocles::Event::Pages event.

register

Register this plugin to install its event handlers. Called automatically.

AUTHOR

Doug Bell <preaction@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2016 by Doug Bell.

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

                    cpanm Statocles::Plugin::LinkCheck

                    perl -MCPAN -e shell
                    install Statocles::Plugin::LinkCheck