.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Markdent::Parser 3pm"
.TH Markdent::Parser 3pm "2019-01-26" "perl v5.28.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Markdent::Parser \- A markdown parser
.SH "VERSION"
.IX Header "VERSION"
version 0.33
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  my $handler = Markdent::Handler::HTMLStream\->new( ... );
\&
\&  my $parser = Markdent::Parser\->new(
\&      dialect => ...,
\&      handler => $handler,
\&  );
\&
\&  $parser\->parse( markdown => $markdown );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class provides the primary interface for creating a parser. It ties a
block and span parser together with a handler.
.PP
By default, it will parse the standard Markdown dialect, but you can provide
alternate block or span parser classes.
.SH "METHODS"
.IX Header "METHODS"
This class provides the following methods:
.SS "Markdent::Parser\->new(...)"
.IX Subsection "Markdent::Parser->new(...)"
This method creates a new parser. It accepts the following parameters:
.IP "\(bu" 4
dialects => \f(CW$name\fR or [ \f(CW$name1\fR, \f(CW$name2\fR ]
.Sp
You can use this to apply dialect roles to the standard parser class.
.Sp
If a dialect name does not contain a namespace separator (::), the constructor
looks for roles named \f(CW\*(C`Markdent::Dialect::${dialect}::BlockParser\*(C'\fR and
\&\f(CW\*(C`Markdent::Dialect::${dialect}::SpanParser\*(C'\fR.
.Sp
If a dialect name does contain a namespace separator, it is used a prefix \-
\&\f(CW$dialect::BlockParser\fR and \f(CW$dialect::SpanParser\fR.
.Sp
If any relevant roles are found, they will be used by the parser.
.Sp
It is okay if a given dialect only provides a block or span parser, but not
both.
.IP "\(bu" 4
block_parser_class => \f(CW$class\fR
.Sp
This defaults to Markdent::Parser::BlockParser, but can be any class which
implements the Markdent::Role::BlockParser role.
.IP "\(bu" 4
span_parser_class => \f(CW$class\fR
.Sp
This defaults to Markdent::Parser::SpanParser, but can be any class which
implements the Markdent::Role::SpanParser role.
.IP "\(bu" 4
handler => \f(CW$handler\fR
.Sp
This can be any object which implements the Markdent::Role::Handler
role. It is required.
.ie n .SS "$parser\->parse( markdown => $markdown )"
.el .SS "\f(CW$parser\fP\->parse( markdown => \f(CW$markdown\fP )"
.IX Subsection "$parser->parse( markdown => $markdown )"
This method parses the given document. The parsing will cause events to be
fired which will be passed to the parser's handler.
.SH "ROLES"
.IX Header "ROLES"
This class does the Markdent::Role::EventsAsMethods and
Markdent::Role::Handler roles.
.SH "BUGS"
.IX Header "BUGS"
See Markdent for bug reporting details.
.PP
Bugs may be submitted at <https://github.com/houseabsolute/Markdent/issues>.
.PP
I am also usually active on \s-1IRC\s0 as 'autarch' on \f(CW\*(C`irc://irc.perl.org\*(C'\fR.
.SH "SOURCE"
.IX Header "SOURCE"
The source code repository for Markdent can be found at <https://github.com/houseabsolute/Markdent>.
.SH "AUTHOR"
.IX Header "AUTHOR"
Dave Rolsky <autarch@urth.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2019 by Dave Rolsky.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
.PP
The full text of the license can be found in the
\&\fI\s-1LICENSE\s0\fR file included with this distribution.