Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
branch: master

This branch is 0 commits ahead and 0 commits behind master

Fetching latest commit…

Cannot retrieve the latest commit at this time

README
NAME
    Pod::Markdown - Convert POD to Markdown

VERSION
    version 1.103490

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.

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.

INSTALLATION
    See perlmodinstall for information and options on installing Perl
    modules.

BUGS AND LIMITATIONS
    No bugs have been reported.

    Please report any bugs or feature requests through the web interface at
    <http://rt.cpan.org/Public/Dist/Display.html?Name=Pod-Markdown>.

AVAILABILITY
    The latest version of this module is available from the Comprehensive
    Perl Archive Network (CPAN). Visit <http://www.perl.com/CPAN/> to find a
    CPAN site near you, or see <http://search.cpan.org/dist/Pod-Markdown/>.

    The development version lives at
    <http://github.com/hanekomu/Pod-Markdown.git> and may be cloned from
    <git://github.com/hanekomu/Pod-Markdown.git>. Instead of sending
    patches, please fork this project using the standard git and github
    infrastructure.

AUTHORS
    *   Marcel Gruenauer <marcel@cpan.org>

    *   Victor Moral <victor@taquiones.net>

    *   Ryan C. Thompson

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.

Something went wrong with that request. Please try again.