Rand Stats

Pod::To::Markdown

zef:raku-community-modules

Actions Status Actions Status Actions 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;  # exports pod2markdown

print pod2markdown($=pod);

=head1 DESCRIPTION

=head2 method render

=begin code :lang<raku>
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()

AUTHORS

and many others.

COPYRIGHT AND LICENSE

Copyright 2014 - 2015 Jorn van Engelen

Copyright 2016 - 2020 Tim Smith

Copyright 2021 - 2024 Tim Siegel

Copyright 2025 The Raku Community

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