Kent Fredric │‫3﹪🔋
and 1 contributors

NAME

CPAN::Changes::Markdown - Format your Changes file ( or a section of it ) in Markdown

VERSION

version 1.000001

SYNOPSIS

    use CPAN::Changes::Markdown;

    my $changes = CPAN::Changes::Markdown->load_utf8( $path_to_changes_file );

    print $changes->serialize # emits Markdown

DESCRIPTION

Mostly, this is wrapper around CPAN::Changes that just formats the output differently.

Primary use case for me is writing GitHub release notes.

I plan to eventually have hook filters and stuff to highlight various tokens in a GitHub friendly way.

METHODS

load

    my $ccm = CPAN::Changes::Markdown->load( path/to/file );

load_string

    my $ccm = CPAN::Changes::Markdown->load_string( "some text" );

load_utf8

Same as load except opens file in utf8 mode.

    my $ccm = CPAN::Changes::Markdown->load_utf8( path/to/file  );

serialize

    my $string = $ccm->serialize();

ATTRIBUTES

changes

header_filter

A CPAN::Changes::Markdown::Filter object that can process a header.

line_filter

A CPAN::Changes::Markdown::Filter object that can process a line.

AUTHOR

Kent Fredric <kentnl@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2015 by Kent Fredric <kentfredric@gmail.com>.

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