Pod::Markdown::Passthrough - A passthrough mode for Pod::Markdown.
use Pod::Markdown::Passthrough; my $parser = Pod::Markdown::Passthrough->new(); $parser->parse_from_file($file_containing_markdown); # Outputs the raw contents of $file_containing_markdown. print $parser->as_markdown;
Pod::Markdown::Passthrough is a child class of Pod::Markdown which makes the assumption that the source file is already markdown, and performs no processing of it at all.
github-aware CPAN module authoring tools such as Minilla build README.md from the module POD, but sometimes you want the README.md to be something specific, and independent of the module POD.
For example, using Minilla, add the following two lines to minil.toml to have the build process leave README.md untouched.
minil.toml
readme_from="README.md" markdown_maker="Pod::Markdown::Passthrough"
Only the parse_from_file() and as_markdown() methods of Pod::Markdown are replaced, so calling any other methods on the object is very unlikely to do what you'd expect.
parse_from_file()
as_markdown()
Copyright (C) Dave Webb.
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
Dave Webb <github@d5ve.com>
To install Pod::Markdown::Passthrough, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Pod::Markdown::Passthrough
CPAN shell
perl -MCPAN -e shell install Pod::Markdown::Passthrough
For more information on module installation, please visit the detailed CPAN module installation guide.