ASPEER-MakeMaker-Markdown-Pod

 view release on metacpan or  search on metacpan

README  view on Meta::CPAN


The MakeMaker integration is deliberately separate from Markdown
processing:

- ASPEER::MakeMaker::Markdown::Pod inherits the common lifecycle
  behavior from ASPEER::MakeMaker.
- ASPEER::MakeMaker::MM::Import installs and implements the MakeMaker
  lifecycle hooks.
- ASPEER::MakeMaker::Markdown::Pod::MM defines and runs the doc and
  readme targets.
- Markdown::Pod::Embed selects Markdown, converts it to POD, and updates
  the Perl source.

The integration is loaded automatically when
ASPEER::MakeMaker::Markdown::Pod is imported by Makefile.PL. It
preserves local library paths and the active MakeMaker extensions in the
generated global PERLRUN command.

make doc : Recursively converts DocBook article XML beneath doc/ to
sibling Markdown files, independently of MANIFEST. It then processes
Markdown sidecars listed in MANIFEST and merges them into matching .pm,

README.md  view on Meta::CPAN


# MAKE TARGETS

The MakeMaker integration is deliberately separate from Markdown processing:

- `ASPEER::MakeMaker::Markdown::Pod` inherits the common lifecycle behavior
  from `ASPEER::MakeMaker`.
- `ASPEER::MakeMaker::MM::Import` installs and implements the MakeMaker
  lifecycle hooks.
- `ASPEER::MakeMaker::Markdown::Pod::MM` defines and runs the `doc` and `readme` targets.
- `Markdown::Pod::Embed` selects Markdown, converts it to POD, and updates the
  Perl source.

The integration is loaded automatically when `ASPEER::MakeMaker::Markdown::Pod` is
imported by `Makefile.PL`. It preserves local library paths and the active
MakeMaker extensions in the generated global `PERLRUN` command.

`make doc`
: Recursively converts DocBook article XML beneath `doc/` to sibling Markdown
  files, independently of `MANIFEST`. It then processes Markdown sidecars listed
  in `MANIFEST` and merges them into matching `.pm`, `.pl`, or executable targets.

lib/ASPEER/MakeMaker/Markdown/Pod.pm  view on Meta::CPAN

The responsibilities are deliberately separated:

- `ASPEER::MakeMaker::Markdown::Pod` inherits the common MakeMaker behavior
  from `ASPEER::MakeMaker`.
- `ASPEER::MakeMaker::MM::Import` installs and implements the MakeMaker
  lifecycle hooks.
- `ASPEER::MakeMaker::Markdown::Pod::MM` generates and executes the `doc` and `readme`
  targets.
- `Docbook::Convert::Pandoc` discovers DocBook articles beneath `doc/` and
  converts them to sibling Markdown files.
- `Markdown::Pod::Embed` selects Markdown, converts it to POD, and updates Perl
  source files.

The `doc` target discovers DocBook articles beneath `doc/` independently of
`MANIFEST`, converts them to sibling Markdown files, and then processes Markdown
sidecars listed in `MANIFEST` for matching Perl modules, scripts, and declared
executable files. `readme` renders the best available README Markdown source as
plain text.

# PROCESSOR COMPATIBILITY

lib/ASPEER/MakeMaker/Markdown/Pod.pm  view on Meta::CPAN



=item -

C<Docbook::Convert::Pandoc> discovers DocBook articles beneath C<doc/> and
  converts them to sibling Markdown files.


=item -

C<Markdown::Pod::Embed> selects Markdown, converts it to POD, and updates Perl
  source files.


=back

The C<doc> target discovers DocBook articles beneath C<doc/> independently of
C<MANIFEST>, converts them to sibling Markdown files, and then processes Markdown
sidecars listed in C<MANIFEST> for matching Perl modules, scripts, and declared
executable files. C<readme> renders the best available README Markdown source as
plain text.

lib/ASPEER/MakeMaker/Markdown/Pod.pm.md  view on Meta::CPAN

The responsibilities are deliberately separated:

- `ASPEER::MakeMaker::Markdown::Pod` inherits the common MakeMaker behavior
  from `ASPEER::MakeMaker`.
- `ASPEER::MakeMaker::MM::Import` installs and implements the MakeMaker
  lifecycle hooks.
- `ASPEER::MakeMaker::Markdown::Pod::MM` generates and executes the `doc` and `readme`
  targets.
- `Docbook::Convert::Pandoc` discovers DocBook articles beneath `doc/` and
  converts them to sibling Markdown files.
- `Markdown::Pod::Embed` selects Markdown, converts it to POD, and updates Perl
  source files.

The `doc` target discovers DocBook articles beneath `doc/` independently of
`MANIFEST`, converts them to sibling Markdown files, and then processes Markdown
sidecars listed in `MANIFEST` for matching Perl modules, scripts, and declared
executable files. `readme` renders the best available README Markdown source as
plain text.

# PROCESSOR COMPATIBILITY

lib/ASPEER/MakeMaker/Markdown/Pod/MM.pm  view on Meta::CPAN

```bash
perl Makefile.PL
make doc
make readme
```

# DESCRIPTION

`ASPEER::MakeMaker::Markdown::Pod::MM` generates and executes the documentation targets
used by `ExtUtils::MakeMaker`. DocBook article conversion is delegated to
`Docbook::Convert::Pandoc`. Markdown source selection, Markdown-to-POD conversion,
and Perl source updates are delegated to `Markdown::Pod::Embed`.

This class inherits the common MakeMaker namespace from
`ASPEER::MakeMaker::MM` and imports shared helper functions from
`ASPEER::MakeMaker::MM::Util`.

`ASPEER::MakeMaker::MM::Import` installs the MakeMaker lifecycle hooks and
appends the target template. This module handles the resulting `doc` and
`readme` invocations.

lib/ASPEER/MakeMaker/Markdown/Pod/MM.pm  view on Meta::CPAN



 perl Makefile.PL
 make doc
 make readme

=head1 DESCRIPTION

C<ASPEER::MakeMaker::Markdown::Pod::MM> generates and executes the documentation targets
used by C<ExtUtils::MakeMaker>. DocBook article conversion is delegated to
C<Docbook::Convert::Pandoc>. Markdown source selection, Markdown-to-POD conversion,
and Perl source updates are delegated to C<Markdown::Pod::Embed>.

This class inherits the common MakeMaker namespace from
C<ASPEER::MakeMaker::MM> and imports shared helper functions from
C<ASPEER::MakeMaker::MM::Util>.

C<ASPEER::MakeMaker::MM::Import> installs the MakeMaker lifecycle hooks and
appends the target template. This module handles the resulting C<doc> and
C<readme> invocations.

lib/ASPEER/MakeMaker/Markdown/Pod/MM.pm.md  view on Meta::CPAN

```bash
perl Makefile.PL
make doc
make readme
```

# DESCRIPTION

`ASPEER::MakeMaker::Markdown::Pod::MM` generates and executes the documentation targets
used by `ExtUtils::MakeMaker`. DocBook article conversion is delegated to
`Docbook::Convert::Pandoc`. Markdown source selection, Markdown-to-POD conversion,
and Perl source updates are delegated to `Markdown::Pod::Embed`.

This class inherits the common MakeMaker namespace from
`ASPEER::MakeMaker::MM` and imports shared helper functions from
`ASPEER::MakeMaker::MM::Util`.

`ASPEER::MakeMaker::MM::Import` installs the MakeMaker lifecycle hooks and
appends the target template. This module handles the resulting `doc` and
`readme` invocations.

lib/ASPEER/MakeMaker/Markdown/Pod/MM/Constant.pm  view on Meta::CPAN

my $postamble = $TEMPLATE_POSTAMBLE_FN;
my $module    = $MARKPOD_PM;
my $argv      = $MARKPOD_PM_ARGV;
```

# DESCRIPTION

`ASPEER::MakeMaker::Markdown::Pod::MM::Constant` defines constants used by
`ASPEER::MakeMaker::Markdown::Pod::MM` when it extends `ExtUtils::MakeMaker`.

`MM_PREFIX` selects the private `MARKPOD_*` Makefile macro namespace used by
the shared hook implementation. It is hook configuration and is not emitted as
a generic `MM_PREFIX` Makefile macro.

The constants describe where the Makefile postamble template lives, which Perl
module should be invoked by the generated targets, and which MakeMaker
variables should be passed back into the target dispatcher.

# CONSTANTS

`$TEMPLATE_POSTAMBLE_FN`

lib/ASPEER/MakeMaker/Markdown/Pod/MM/Constant.pm  view on Meta::CPAN


 my $postamble = $TEMPLATE_POSTAMBLE_FN;
 my $module    = $MARKPOD_PM;
 my $argv      = $MARKPOD_PM_ARGV;

=head1 DESCRIPTION

C<ASPEER::MakeMaker::Markdown::Pod::MM::Constant> defines constants used by
C<ASPEER::MakeMaker::Markdown::Pod::MM> when it extends C<ExtUtils::MakeMaker>.

C<MM_PREFIX> selects the private C<MARKPOD_*> Makefile macro namespace used by
the shared hook implementation. It is hook configuration and is not emitted as
a generic C<MM_PREFIX> Makefile macro.

The constants describe where the Makefile postamble template lives, which Perl
module should be invoked by the generated targets, and which MakeMaker
variables should be passed back into the target dispatcher.


=head1 CONSTANTS

lib/ASPEER/MakeMaker/Markdown/Pod/MM/Constant.pm.md  view on Meta::CPAN

my $postamble = $TEMPLATE_POSTAMBLE_FN;
my $module    = $MARKPOD_PM;
my $argv      = $MARKPOD_PM_ARGV;
```

# DESCRIPTION

`ASPEER::MakeMaker::Markdown::Pod::MM::Constant` defines constants used by
`ASPEER::MakeMaker::Markdown::Pod::MM` when it extends `ExtUtils::MakeMaker`.

`MM_PREFIX` selects the private `MARKPOD_*` Makefile macro namespace used by
the shared hook implementation. It is hook configuration and is not emitted as
a generic `MM_PREFIX` Makefile macro.

The constants describe where the Makefile postamble template lives, which Perl
module should be invoked by the generated targets, and which MakeMaker
variables should be passed back into the target dispatcher.

# CONSTANTS

`$TEMPLATE_POSTAMBLE_FN`



( run in 1.296 second using v1.01-cache-2.11-cpan-1bcd28dbaf1 )