Markdent::Simple::Document - Convert Markdown to an HTML Document
version 0.27
use Markdent::Simple::Document; my $mds = Markdent::Simple::Document->new(); my $html = $mds->markdown_to_html( title => 'My Document', markdown => $markdown, );
This class provides a very simple interface for converting Markdown to a complete HTML document.
This class provides the following methods:
Creates a new Markdent::Simple::Document object.
This method turns Markdown into HTML. It accepts the following parameters:
title => $title
The title of the document. This is required.
charset => $charset
If provided, a <meta charset="..."> tag will be added to the document's <head>.
<meta charset="...">
<head>
language => $language
If provided, a "lang" attribute will be added to the document's <html> tag.
<html>
dialects => [...]
This can either be a single string or an array ref of strings containing the class names of dialects. This parameter is optional.
This class does the Markdent::Role::Simple role.
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.
irc://irc.perl.org
The source code repository for Markdent can be found at https://github.com/houseabsolute/Markdent.
Dave Rolsky <autarch@urth.org>
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.
To install Markdent, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Markdent
CPAN shell
perl -MCPAN -e shell install Markdent
For more information on module installation, please visit the detailed CPAN module installation guide.