view release on metacpan or  search on metacpan

lib/Pod/Markdown/Passthrough.pm  view on Meta::CPAN

package Pod::Markdown::Passthrough;
use 5.008001;
use strict;
use warnings;

use base 'Pod::Markdown';

our $VERSION = "0.01";

sub new {
    my $class = shift;

    bless {}, $class;
}

# Read the contents of a file and stash in object.
sub parse_from_file {
    my $self = shift;
    my $file = shift;

    $self->{_markdown} = do { local ( @ARGV, $/ ) = $file; <> };

}

# Return any stashed raw file content.
sub as_markdown {
    my $self = shift;

    return $self->{_markdown};

}

1;
__END__

=encoding utf-8

=head1 NAME

Pod::Markdown::Passthrough - A passthrough mode for Pod::Markdown.

=head1 SYNOPSIS

    use Pod::Markdown::Passthrough;

    my $parser = Pod::Markdown::Passthrough->new();
    $parser->parse_from_file($file_containing_markdown);
    # Outputs the raw contents of $file_containing_markdown.
    print $parser->as_markdown;

=head1 DESCRIPTION

Pod::Markdown::Passthrough is a child class of Pod::Markdown which makes the
assumption that the source file is already markdown, and performs no processing
of it at all.

github-aware CPAN module authoring tools such as L<Minilla> build README.md
from the module POD, but sometimes you want the README.md to be something
specific, and independent of the module POD.

For example, using L<Minilla>, add the following two lines to C<minil.toml> to
have the build process leave README.md untouched.

    readme_from="README.md"
    markdown_maker="Pod::Markdown::Passthrough"

=head1 CAVEATS

=over

=item * Only the C<parse_from_file()> and C<as_markdown()> methods of
L<Pod::Markdown> are replaced, so calling any other methods on the object is
I<very unlikely> to do what you'd expect.

=back

=head1 LICENSE

Copyright (C) Dave Webb.

This library is free software; you can redistribute it and/or modify