Sha256: 2aee1e63d320f684d3b91bbc3f1be6976801c157457d20a3b02835df49eb836b
Contents?: true
Size: 1.06 KB
Versions: 1
Compression:
Stored size: 1.06 KB
Contents
=begin pod
=TITLE Pod::To::HTML
Render Pod6 as HTML
=begin SYNOPSIS
Use it integrated with Perl 6 documentation system
perl6 --doc=HTML lib/FancyModule.pm > FancyModule.html
Or as an external function to render your documentation
=begin code
=pod My I<super B<awesome>> embedded C<pod> document!
say Pod::To::HTML.render($=pod[0]);
=end code
=end SYNOPSIS
=begin DESCRIPTION
B<C<Pod::To::HTML>> takes a C<Pod> tree and outputs correspondingly
formatted C<HTML>. Generally this is via C<perl6 --doc=HTML>, which
extracts the pod from the document and feeds it to C<Pod::To::HTML>. The
other route is with the C<render> method (called by C<--doc=HTML>),
which creates a complete C<HTML> document from the C<Pod> tree it is
called with.
=end DESCRIPTION
=begin LICENSE
You can use and distribute this module under the terms of the The Artistic License 2.0. See the LICENSE file included in this distribution for complete details.
The META6.json file of this distribution may be distributed and modified without restrictions or attribution.
=end LICENSE
=end pod
Version data entries
1 entries across 1 versions & 1 rubygems
| Version | Path |
|---|---|
| github-markup-3.0.2 | vendor/Pod-To-HTML/README.pod6 |