Raku Land

Pod::To::Markdown

cpan:SOFTMOTH

Build Status Windows Status

NAME

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

SYNOPSIS

From command line:

$ raku --doc=Markdown lib/To/Class.rakumod

From Raku:

use Pod::To::Markdown;

=NAME
foobar.pl

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

print pod2markdown($=pod);

EXPORTS

class Pod::To::Markdown
sub pod2markdown

DESCRIPTION

method render

method render($pod, Bool :$no-fenced-codeblocks --> 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 ```raku to enable syntax highlighting on certain markdown renderers, use:

=begin code :lang<raku>

sub pod2markdown

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

Render Pod as Markdown, see .render()

LICENSE

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