NAME
App::MarkdownUtils - Collection of CLI utilities related to Markdown
VERSION
This document describes version 0.02 of App::MarkdownUtils (from Perl distribution App-MarkdownUtils), released on 2016-01-31.
DESCRIPTION
This distribution provides the following command-line utilities related to Markdown:
FUNCTIONS
markdown_to_html(%args) -> [status, msg, result, meta]
Convert Markdown to HTML.
Currently using Text::Markdown perl module.
This function is not exportable.
Arguments ('*' denotes required arguments):
markdown* => str
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
markdown_to_pod(%args) -> [status, msg, result, meta]
Convert Markdown to POD.
Currently using Markdown::To::POD perl module.
This function is not exportable.
Arguments ('*' denotes required arguments):
markdown* => str
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
HOMEPAGE
Please visit the project's homepage at https://metacpan.org/release/App-MarkdownUtils.
SOURCE
Source repository is at https://github.com/perlancar/perl-App-MarkdownToPODUtils.
BUGS
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-MarkdownUtils
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
SEE ALSO
AUTHOR
perlancar <perlancar@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2016 by perlancar@cpan.org.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.