Dave Rolsky > Markdent-0.24 > Markdent::Simple::Document

Download:
Markdent-0.24.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

Open  2
View/Report Bugs
Module Version: 0.24   Source  

NAME ^

Markdent::Simple::Document - Convert Markdown to an HTML Document

VERSION ^

version 0.24

SYNOPSIS ^

    use Markdent::Simple::Document;

    my $mds  = Markdent::Simple::Document->new();
    my $html = $mds->markdown_to_html(
        title    => 'My Document',
        markdown => $markdown,
    );

DESCRIPTION ^

This class provides a very simple interface for converting Markdown to a complete HTML document.

METHODS ^

This class provides the following methods:

Markdent::Simple::Document->new()

Creates a new Markdent::Simple::Document object.

$mds->markdown_to_html( title => $title, markdown => $markdown )

This method turns Markdown into HTML. You must provide a title as well, which will be used as the <title> for the resulting HTML document.

You can also provide an optional "dialect" parameter.

ROLES ^

This class does the Markdent::Role::Simple role.

BUGS ^

See Markdent for bug reporting details.

AUTHOR ^

Dave Rolsky <autarch@urth.org>

CONTRIBUTOR ^

Jason McIntosh <jmac@appleseed-sc.com>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2014 by Dave Rolsky.

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

syntax highlighting: