Skip to content
master
Go to file
Code
This branch is 65 commits ahead of jpve:master.

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
t
 
 
 
 
xt
 
 
 
 
 
 
 
 
 
 
 
 

README.md

NAME

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

Build Status Windows status

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 ...

print pod2markdown($=pod);

EXPORTS

class Pod::To::Markdown
sub pod2markdown

DESCRIPTION

sub pod2markdown

sub pod2markdown(
    $pod,
    Bool :$no-fenced-codeblocks
) returns Str

Render Pod as Markdown

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>

method render

method render(
    $pod,
    Bool :$no-fenced-codeblocks
) returns Str

Render Pod as Markdown, see pod2markdown

LICENSE

This is free software; you can redistribute it and/or modify it under the terms of The Artistic License 2.0.

About

Render Perl6 Pod as Markdown

Resources

License

You can’t perform that action at this time.