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

Markdent documentation

Contained in the Markdent distribution.

Index

NAME
VERSION
SYNOPSIS
DESCRIPTION
METHODS
- Markdent::Simple::Document->new()
- $mds->markdown_to_html( title => $title, markdown => $markdown )
BUGS
AUTHOR
COPYRIGHT AND LICENSE

Code Index:

package Markdent::Simple::Document
- markdown_to_html
__END__
EOF

NAME

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

VERSION

version 0.17

SYNOPSIS

    use Markdent::Simple::Document;

    my $mds  = Markdent::Simple::Document->new();
    my $html = $mss->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.

BUGS

See Markdent for bug reporting details.

AUTHOR

Dave Rolsky <autarch@urth.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2010 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.

Markdent documentation

Contained in the Markdent distribution.

package Markdent::Simple::Document;
BEGIN {
  $Markdent::Simple::Document::VERSION = '0.17';
}

use strict;
use warnings;

use Markdent::Handler::HTMLStream::Document;
use Markdent::Parser;
use Markdent::Types qw( Str );
use MooseX::Params::Validate qw( validated_list );

use namespace::autoclean;
use Moose;
use MooseX::StrictConstructor;

sub markdown_to_html {
    my $self = shift;
    my ( $dialect, $title, $markdown ) = validated_list(
        \@_,
        dialect  => { isa => Str, default => 'Standard' },
        title    => { isa => Str },
        markdown => { isa => Str },
    );

    my $capture = q{};
    open my $fh, '>', \$capture
        or die $!;

    my $handler = Markdent::Handler::HTMLStream::Document->new(
        title  => $title,
        output => $fh,
    );

    my $parser
        = Markdent::Parser->new( dialect => $dialect, handler => $handler );

    $parser->parse( markdown => $markdown );

    return $capture;
}

1;

# ABSTRACT: Convert Markdown to an HTML Document


__END__