Skip to content

zag/p5-Podlite

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🌟 Podlite is a lightweight block-based markup language designed for flexibility and ease of use 🌟

Podlite

This module is a source filter that allows you to use Podlite markup language in your Perl programs.

Installation

perl Makefile.PL
make
make test
make install

Synopsis

use Podlite;

my $x = 1;

=head1 DESCRIPTION
=para This documentation block will be filtered out during compilation,
but you can still use it for generating documentation.

my $y = 2;
print "Sum: ", $x + $y, "\n";

Features

  • Source filtering - Strips Podlite markup during compilation
  • Line number preservation - Accurate error reporting
  • Data blocks - Access embedded data via *DATA filehandle

Quick Examples

Task List

=head1 TODO

=item [x] Implement basic functionality
=item [x] Write documentation
=item [ ] Add test suite
=item [ ] Publish to CPAN

Table with Caption

=begin table :caption<Performance Benchmarks>
Operation      Time (ms)   Memory (MB)
Parse          45          12
Render         23          8
Export         67          15
=end table

Notification Block

=begin nested :notify<warning> :caption<Important Note>
This feature is experimental and may change in future releases.
=end nested

Code Block with Language

=begin code :lang<perl>
sub calculate {
    my ($x, $y) = @_;
    return $x + $y;
}
=end code

Markdown Block

use Podlite;

my $version = "1.0";

=begin markdown
# Project Documentation

Mix **markdown** formatting with Podlite!

## Features
- Easy to read
- Easy to write
- Works seamlessly with Perl code

Example code:
\```perl
my $result = 2 + 2;
\```
=end markdown

print "Version: $version\n";

Documentation

For complete documentation, run:

perldoc Podlite

Or see the Podlite Specification for a comprehensive reference.

Podlite Ecosystem

Specification

Implementation

Publishing System

Desktop Viewer/Editor

Online Resources

Author

Aliaksandr Zahatski zag@cpan.org

Credits

Damian Conway - for inspiration and source filter techniques

License

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

About

This module lets you use the Podlite markup language inside your Perl programs

Topics

Resources

Stars

Watchers

Forks

Languages