Randy Stauner > Pod-Markdown-1.322 > Pod::Markdown

Download:
Pod-Markdown-1.322.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

Open  1
View/Report Bugs
Module Version: 1.322   Source   Latest Release: Pod-Markdown-2.001

NAME ^

Pod::Markdown - Convert POD to Markdown

VERSION ^

version 1.322

SYNOPSIS ^

    my $parser = Pod::Markdown->new;
    $parser->parse_from_filehandle(\*STDIN);
    print $parser->as_markdown;

DESCRIPTION ^

This module subclasses Pod::Parser and converts POD to Markdown.

Literal characters in Pod that are special in Markdown (like *asterisks*) are backslash-escaped (except those in verbatim blocks or C<code> sections).

METHODS ^

initialize

Initializes a newly constructed object.

as_markdown

Returns the parsed POD as Markdown. Takes named arguments. If the with_meta argument is given a positive value, meta tags are generated as well.

command

Handles POD command paragraphs, denoted by a line beginning with =.

verbatim

Handles verbatim text.

textblock

Handles normal blocks of POD.

interior_sequence

Handles interior sequences in POD. An interior sequence is an embedded command within a block of text which appears as a command name - usually a single uppercase character - followed immediately by a string of text which is enclosed in angle brackets.

format_header

Formats a header according to the given level.

SEE ALSO ^

SUPPORT ^

Perldoc

You can find documentation for this module with the perldoc command.

  perldoc Pod::Markdown

Websites

The following websites have more information about this module, and may be of help to you. As always, in addition to those websites please use your favorite search engine to discover more resources.

Bugs / Feature Requests

Please report any bugs or feature requests by email to bug-pod-markdown at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Pod-Markdown. You will be automatically notified of any progress on the request by the system.

Source Code

https://github.com/rwstauner/Pod-Markdown

  git clone https://github.com/rwstauner/Pod-Markdown.git

AUTHORS ^

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2004 by Marcel Gruenauer.

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

syntax highlighting: