Program to render Perl6 Pod documentation
pod-render.pl6 --pdf bin/pod-render.pl6
pod-render.pl6 [<options> ...] <pod-file | pod-dir> ...
This is the file where to find the pod documentation and is rendered. The result is placed in the current directory or, when a directory doc exists, in that directory. A pod file is checked to have at least 5 pod render commands like =begin ...
or =for ...
to get rendered.
Search directory and subdirectories for perl6 pod documentation looking for extensions .pl6, .pm6, .pod6, .pl, .pm or .pod.
Generate a list of markdown references into the file markdown-refs.md. The format of this file will be like the following;
[pod-render.pl6 html]: https://nbviewer.jupyter.org/github/MARTIMM/pod ... [pod-render.pl6 pdf]: https://nbviewer.jupyter.org/github/MARTIMM/pod- ... [pod-render.pl6 md]: https://github.com/MARTIMM/pod-render/blob/master ... ...
Where the github path is github.com/MARTIMM/pod-render and the pod files are found at bin/pod-render.pl6 and lib/Pod/Render.pm6.
Generate output in html format. This is the default. Result is placed in the current directory or in the ./doc directory if it exists.
Generate output in md format. Result is placed in current directory or in the ./doc directory if it exists.
Generate output in pdf format. Result is placed in current directory or in the ./doc directory if it exists. Pdf is generated using the program prince so that must be installed. See downloads.