1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140
|
package Markdent::Simple::Fragment;
use strict;
use warnings;
use namespace::autoclean;
our $VERSION = '0.40';
use Markdent::Handler::HTMLStream::Fragment;
use Markdent::Parser;
use Markdent::Types;
use Params::ValidationCompiler qw( validation_for );
use Specio::Declare;
use Moose;
use MooseX::StrictConstructor;
with 'Markdent::Role::Simple';
{
my $validator = validation_for(
params => [
dialects => {
type => union(
of => [
t('Str'),
t( 'ArrayRef', of => t('Str') )
]
),
default => sub { [] },
},
markdown => { type => t('Str') },
],
named_to_list => 1,
);
sub markdown_to_html {
my $self = shift;
my ( $dialects, $markdown ) = $validator->(@_);
my $handler_class = 'Markdent::Handler::HTMLStream::Fragment';
return $self->_parse_markdown(
$markdown,
$dialects,
$handler_class,
);
}
}
__PACKAGE__->meta->make_immutable;
1;
# ABSTRACT: Convert Markdown to an HTML Fragment
__END__
=pod
=encoding UTF-8
=head1 NAME
Markdent::Simple::Fragment - Convert Markdown to an HTML Fragment
=head1 VERSION
version 0.40
=head1 SYNOPSIS
use Markdent::Simple::Fragment;
my $mds = Markdent::Simple::Fragment->new;
my $html = $mds->markdown_to_html(
markdown => $markdown,
);
=head1 DESCRIPTION
This class provides a very simple interface for converting Markdown to an HTML
fragment.
=head1 METHODS
This class provides the following methods:
=head2 Markdent::Simple::Fragment->new
Creates a new Markdent::Simple::Fragment object.
=head2 $mdf->markdown_to_html( markdown => $markdown )
This method turns Markdown into HTML. It accepts the following parameters:
=over 4
=item * markdown
This is the markdown to pass. This argument is required.
=item * dialects
This can either be a single string or an array ref of strings containing the
class names of dialects. This parameter is optional.
=back
=head1 ROLES
This class does the L<Markdent::Role::Simple> role.
=head1 BUGS
See L<Markdent> for bug reporting details.
Bugs may be submitted at L<https://github.com/houseabsolute/Markdent/issues>.
I am also usually active on IRC as 'autarch' on C<irc://irc.perl.org>.
=head1 SOURCE
The source code repository for Markdent can be found at L<https://github.com/houseabsolute/Markdent>.
=head1 AUTHOR
Dave Rolsky <autarch@urth.org>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2021 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.
The full text of the license can be found in the
F<LICENSE> file included with this distribution.
=cut
|