Render Perl6 Pod as Markdown
Perl 6
Switch branches/tags
Nothing to show
Pull request Compare This branch is 43 commits ahead of jpve:master.
Latest commit ba3d7d6 Sep 1, 2017 @softmoth committed on GitHub Merge pull request #10 from samcv/signature
Have :no-fenced-codeblocks argument work for signatures

README.md

Pod::To::Markdown (Perl6)

[Build Status](https://travis-ci.org/softmoth/perl6-pod-to-markdo wn)

Installation

Using zef (preferred)

$ zef update
$ zef install Pod::To::Markdown

Using panda:

$ panda update
$ panda install Pod::To::Markdown

NAME

Pod::To::Markdown - Render Pod as Markdown

SYNOPSIS

From command line:

$ perl6 --doc=Markdown lib/to/class.pm

From Perl6:

use Pod::To::Markdown;

=NAME
foobar.pl

=SYNOPSIS
    foobar.pl <options> files ...

say pod2markdown($=pod);

To render without fenced codeblocks ```, as some markdown engines don't support this, use the :no-fenced-codeblocks option. If you want to have code show up as ```perl6 to enable syntax highlighting on certain markdown renderers, use: =begin code :lang<perl6>

EXPORTS

class Pod::To::Markdown;
sub pod2markdown; # See below

DESCRIPTION

sub pod2markdown

sub pod2markdown(
    Pod::Heading $pod,
    Bool :$no-fenced-codeblocks
) returns Mu

Render Pod as Markdown