Marquee Marquee::Plugin::PODRenderer - POD renderer plugin

TABLE OF CONTENTS

NAME

Marquee::Plugin::PODRenderer - POD renderer plugin

SYNOPSIS

$app->plugin('PODViewer');

# on brower the following url for example will be available.
#
# http://localhost:3000/perldoc/LWP

DESCRIPTION

This is a plugin for POD Viewer server.

ATTRIBUTES

Marquee::Plugin::PODViewer inherits all attributes from Marquee::Plugin and implements the following new ones.

no_see_also

Disables auto detection of relative modules, defaults to undef(enabled).

$self->no_see_also(1);
my $bool = $self->no_see_also;

paths

A path to discover modules.

$plugin->paths([$path1, $path2, $path3]);
my $paths = $plugin->paths;

INSTANCE METHODS

Marquee::Plugin::PODViewer inherits all instance methods from Marquee::Plugin and implements the following new ones.

register

Register the plugin.

$self->register($app);

serve_index

Serves index of modules.

$plugin->serve_index;

serve_pod

Parse POD string and generate HTML. optional parameter $mod_name specifies module name and used for see also detection.

$plugin->serve_pod($pod, 'Path::To::Mod');

serve_pod_by_name

Generate HTML by given module name.

$plugin->serve_pod_by_name('Path::To::Mod');

SEE ALSO

Marquee, Mojolicious