Scroll to navigation

Text::Markup::Multimarkdown(3pm) User Contributed Perl Documentation Text::Markup::Multimarkdown(3pm)

Name

Text::Markup::Multimarkdown - MultiMarkdown parser for Text::Markup

Synopsis

  my $html = Text::Markup->new->parse(file => 'README.md');
  my $raw  = Text::Markup->new->parse(file => 'README.md', raw => 1);

Description

This is the MultiMarkdown <http://fletcherpenney.net/multimarkdown/> parser for Text::Markup. It reads in the file (relying on a BOM <http://www.unicode.org/unicode/faq/utf_bom.html#BOM>), hands it off to Text::MultiMarkdown for parsing, and then returns the generated HTML as an encoded UTF-8 string with an "http-equiv="Content-Type"" element identifying the encoding as UTF-8.

It recognizes files with the following extensions as MultiMarkdown:

.mmd
.mmkd
.mmkdn
.mmdown
.multimarkdown

Normally this module returns the output wrapped in a minimal HTML document skeleton. If you would like the raw output without the skeleton, you can pass the "raw" option to "parse".

Author

David E. Wheeler <david@justatheory.com>

Copyright and License

Copyright (c) 2011-2019 David E. Wheeler. Some Rights Reserved.

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

2019-12-14 perl v5.30.0