NAME

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

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.

ATTRIBUTES

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.