++ed by:
ROMANF ADAMJS POLETTIX ZMUGHAL
2 non-PAUSE users
Author image Stefan G.
and 1 contributors

NAME

pod2github - Convert POD text to Github flavored markdown

VERSION

version 1.000

SYNOPSIS

    # parse STDIN, print to STDOUT
    $ pod2github < POD_File > Markdown_File

    # parse file, print to STDOUT
    $ pod2github input.pod

    # parse file, print to file
    $ pod2github input.pod output.mkdn

    # parse STDIN, print to file
    $ pod2github - output.mkdn

DESCRIPTION

This program uses Pod::Markdown::Github to convert POD into Github Markdown sources.

UTF-8 is the default output encoding if no encoding options are specified (see "OPTIONS").

It accepts two optional arguments:

  • input pod file (defaults to STDIN)

  • output markdown file (defaults to STDOUT)

OPTIONS

--html-encode-chars

A list of characters to encode as HTML entities. Pass a regexp character class, or 1 to mean control chars, high-bit chars, and <&>"'.

See "html_encode_chars" in Pod::Markdown for more information.

--match-encoding (-m)

Use the same =encoding as the input pod for the output file.

--output-encoding (-e)

Specify the encoding for the output file.

--utf8 (-u)

Alias for -e UTF-8.

SEE ALSO

This program is pretty much a straight copy of pod2markdown, which is in turn strongly based on pod2mdwn from Module::Build::IkiWiki.

AUTHOR

Stefan G. <minimal@cpan.org>

CREDITS

This software is based on work by:

  • Marcel Gruenauer <marcel@cpan.org>

  • Victor Moral <victor@taquiones.net>

  • Ryan C. Thompson <rct at thompsonclan d0t org>

  • Aristotle Pagaltzis <pagaltzis@gmx.de>

  • Randy Stauner <rwstauner@cpan.org>

COPYRIGHT AND LICENSE

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