MojoMojo::Formatter::Markdown - MultiMarkdown formatting for your content.

MojoMojo documentation Contained in the MojoMojo distribution.

Index

Code Index:

NAME

Top

MojoMojo::Formatter::Markdown - MultiMarkdown formatting for your content. MultiMarkdown is an extension of Markdown, adding support for tables, footnotes, bibliography, automatic cross-references, glossaries, appendices, definition lists, math syntax, anchor and image attributes, and document metadata.

Markdown syntax: http://daringfireball.net/projects/markdown/syntax MultiMarkdown syntax: http://fletcherpenney.net/multimarkdown/users_guide/multimarkdown_syntax_guide/

DESCRIPTION

Top

This formatter processes content using Text::MultiMarkdown This is a syntax for writing human-friendly formatted text.

METHODS

Top

main_format_content

Calls the formatter. Takes a ref to the content as well as the context object. Note that this is different from the format_content method of non-main formatters. This is because we don't want all main formatters to be called when iterating over pluggable modules in MojoMojo::Schema::ResultSet::Content::format_content.

main_format_content will only be called by <MojoMojo::Formatter::Main>.

Note that Text::Markdown ensures that the output always ends with one newline. The fact that multiple newlines are collapsed into one makese sense, because this is the behavior of HTML towards whispace. The fact that there's always a newline at the end makes sense again, given that the output will always be nested in a block-level element, be it a <p> (most often), <table>, or <div> (when passing HTML through).

SEE ALSO

Top

MojoMojo, Module::Pluggable::Ordered, Text::MultiMarkdown

AUTHORS

Top

Marcus Ramberg <mramberg@cpan.org>

LICENSE

Top

This library is free software. You can redistribute it and/or modify it under the same terms as Perl itself.

MojoMojo documentation Contained in the MojoMojo distribution. 
package MojoMojo::Formatter::Markdown;

use parent qw/MojoMojo::Formatter/;

my $markdown;
eval "use Text::MultiMarkdown";
unless ($@) {
    $markdown = Text::MultiMarkdown->new(
        markdown_in_html_blocks => 0,    # Allow Markdown syntax within HTML blocks.
        use_metadata =>
            0,  # Remove MultiMarkdown behavior change to make the top of the document metadata.
        heading_ids => 0,    # Remove MultiMarkdown behavior change in <hX> tags.
        img_ids     => 0,    # Remove MultiMarkdown behavior change in <img> tags.
    );
}


sub main_format_content {
    my ( $class, $content ) = @_;
    return unless $markdown;

    $$content = $markdown->markdown($$content);
}


1;