Name¶

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

Synopsis¶

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

Description¶

This is the MultiMarkdown <https://fletcherpenney.net/multimarkdown/> parser for Text::Markup. It reads in the file (relying on a BOM <https://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

To change it the files it recognizes, load this module directly and pass a regular expression matching the desired extension(s), like so:

  use Text::Markup::Multimarkdown qr{mmm+};

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 the format options argument to "parse".

In addition, Text::Markup::Mediawiki supports all of the Text::MultiMarkdown options, including:

"use_metadata"

"strip_metadata"

"empty_element_suffix"

"img_ids"

"heading_ids"

"bibliography_title"

"tab_width"

"disable_tables"

"disable_footnotes"

"disable_bibliography"

"disable_definition_lists"

Author¶

David E. Wheeler <david@justatheory.com>

Copyright and License¶

Copyright (c) 2011-2024 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.