Pod-To-Markdown

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

  • Jorn van Engelen

  • Tim Smith

  • Samantha McVey

  • Tim Siegel

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.

# vim: expandtab shiftwidth=4

Pod::To::Markdown v0.2.2

Render Rakudoc as Markdown

Authors

  • Jorn van Engelen
  • Tim Siegel
  • Samantha McVey
  • Tim Smith

License

Artistic-2.0

Dependencies

Pod::To::HTML:ver<0.9.0+>:auth<zef:raku-community-modules>

Test Dependencies

Provides

  • Pod::To::Markdown

The Camelia image is copyright 2009 by Larry Wall. "Raku" is trademark of the Yet Another Society. All rights reserved.