NAME

Liveman::Minillapod2markdown - a plug for minilla, which throws Lib/Mainmodule.md to Readme.md

SYNOPSIS

use Liveman::MinillaPod2Markdown;

my $mark = Liveman::MinillaPod2Markdown->new;

$mark->isa("Pod::Markdown")  # -> 1

use File::Slurper qw/write_text/;
write_text "X.md", "hi!";
write_text "X.pm", "our \$VERSION = 1.0;";

$mark->parse_from_file("X.pm");
$mark->{pm_path}  # => X.pm
$mark->{md_path}  # => X.md

$mark->as_markdown  # => hi!

DESCRIPION

Add the Markdown_maker = "Liveman::MinillaPod2Markdown" to minil.toml, and Minilla will not create README.md from the POD-documenting of the main module, and will take from the same name next to the extension *.md.

SUBROUTINES

as_markdown ()

Plug.

new ()

Constructor.

parse_from_file ($path)

Plug.

parse_options ($options)

Parses !options on the first line:

1. Removes ! and languages behind him.

2. He translates the badge through a comma into a Markdown picture.

Badge List:

1. badges - all badges.

2. github-actions - badge for GitHub tests.

3. metacpan - badge for release.

4. cover - badge for coverage that creates liveman when passing the test in doc/badges/total.svg.

github_path ()

The project path to GitHub: username/repository.

read_md ()

Reads a file with MarkDown-documentation.

read_pm ()

Reads the module.

pm_version ()

The version of the module.

INSTALL

To install this module in your system, follow the following actions [command] (https://metacpan.org/pod/App::cpm):

sudo cpm install -gvv Liveman::MinillaPod2Markdown

AUTHOR

Yaroslav O. Kosmina mailto:dart@cpan.org

LICENSE

⚖ gplv3

COPYRIGHT

The Liveman::MinillaPod2Markdown module is copyright © 2023 Yaroslav O. Kosmina. Rusland. All Rights Reserved.

cpanm Liveman

perl -MCPAN -e shell
install Liveman