Dave Cross

NAME

Template::Provider::Pandoc - expand Markdown templates to HTML

SYNOPSIS

    use Template;
    use Template::Provider::Pandoc;

    my $tt = Template->new(
      LOAD_TEMPLATES = [ Template::Provider::Pandoc->new ],
    );

    $tt->process('template.md', \%vars)

DESCRIPTION

Template::Provider::Pandoc is an extension to the Template Toolkit which automatically converts Markdown files into HTML before they are processed by TT.

USAGE

Like any Template provider module, you will usually use this module by creating an instance of the object and passing that in the LOAD_TEMPLATES parameter to the Template module's new method.

This module can accept all of the standard parameters that can be passed to any Template provider module. See Template::Provider for the full list.

This module accepts two extra parameters, EXTENSIONS, which defines the file extensions that is used to identify files that require conversion, and OUTPUT_FORMAT which defines the the format that template will be converted into.

EXTENSIONS is a hash reference. The default is to only handle Markdown files (which are identified by the extension .md). You can get a full list of the allowed input formats by running

    $ pandoc --list-input-formats

at a command line.

The EXTENSIONS option supports one special option. If you use `*` as an extenstion, then files with any extension will be converted using the supplied format. So code like:

    my $provider = Template::Provider::Pandoc(
        EXTENSIONS => { '*' => 'markdown' },
    );

will lead to all files being pre-processed as Markdown files before being handed to the Template Toolkit.

OUTPUT_FORMAT is a single, scalar value containing the name of an output format. The default value is html. You can get a full list of the allowed putput values by running

    $ pandoc --list-output-values

at a command line.

Template::Provider::Markdown::Pandoc

This module is a successor to Template::Provider::Markdown::Pandoc. This replacement module has all the functionality of the older module, and a lot more besides. And, as a bonus, it has a shorter name!

AUTHOR

Dave Cross <dave@perlhacks.com>

COPYRIGHT

Copyright (c) 2017 Magnum Solutions Ltd. All rights reserved.

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

SEE ALSO

Template, Template::Provider, Pandoc, Template::Provider.