View on
MetaCPAN
Dave Rolsky > Markdent > Markdent::Parser

Download:
Markdent-0.27.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

Open  2
View/Report Bugs
Module Version: 0.27   Source  

NAME ^

Markdent::Parser - A markdown parser

VERSION ^

version 0.27

SYNOPSIS ^

  my $handler = Markdent::Handler::HTMLStream->new( ... );

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

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

DESCRIPTION ^

This class provides the primary interface for creating a parser. It ties a block and span parser together with a handler.

By default, it will parse the standard Markdown dialect, but you can provide alternate block or span parser classes.

METHODS ^

This class provides the following methods:

Markdent::Parser->new(...)

This method creates a new parser. It accepts the following parameters:

$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.

ROLES ^

This class does the Markdent::Role::EventsAsMethods and Markdent::Role::Handler roles.

BUGS ^

See Markdent for bug reporting details.

Bugs may be submitted at http://rt.cpan.org/Public/Dist/Display.html?Name=Markdent or via email to bug-markdent@rt.cpan.org.

I am also usually active on IRC as 'autarch' on irc://irc.perl.org.

SOURCE ^

The source code repository for Markdent can be found at https://github.com/houseabsolute/Markdent.

AUTHOR ^

Dave Rolsky <autarch@urth.org>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2017 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 LICENSE file included with this distribution.

syntax highlighting: