Podlite Quick Tour

Introduction

Podlite is a lightweight markup language that's easy to learn and use. This quick tour will show you the most common features through practical examples.

Basic Structure

Paragraphs

Regular paragraphs are created by simply writing text. No special markers are needed:

This is a regular paragraph. It can contain multiple
lines of text. The text will be automatically
wrapped and formatted.

This is another paragraph, separated by a blank line.

Headings

Headings are created using =head1, =head2, etc. The number indicates the heading level:

=head1 Main Title
=head2 Section Title
=head3 Subsection Title

Lists

Unordered Lists

Create bullet points using =item:

=item First item
=item Second item
=item Third item

Ordered Lists

Add :numbered to create numbered lists:

=for item :numbered
First item
=for item :numbered
Second item
=for item :numbered
Third item

Code Blocks

Show code examples using =code:

=begin code :lang<raku>
sub greet($name) {
    say "Hello, $name!";
}
=end code

Create links using L<>:

Visit our L<website|https://example.com> for more information.

Images

Insert images using =picture:

=picture diagram.png
This is a diagram showing the system architecture.

Tables

Create tables using =table:

=begin table :caption<Programming Languages>
    Language    | Year Created | Creator
    ------------|--------------|----------
    Python      | 1991         | Guido van Rossum
    JavaScript  | 1995         | Brendan Eich
    Raku        | 2015         | Larry Wall
=end table

Text Formatting

Basic Formatting

B<Bold text> using B<>
I<Italic text> using I<>
C<Code text> using C<>

Special Characters

Use E<> for special characters:

E<copy> Copyright symbol
E<euro> Euro symbol
E<:smile:> Emoji

Notifications

Create attention-grabbing blocks using =nested with :notify:

=begin nested :notify<tip>
Remember to save your work frequently!
=end nested

=begin nested :notify<warning>
Be careful when deleting files!
=end nested

Mathematical Formulas

Include mathematical formulas using =formula:

=formula :caption<Quadratic Formula>
x = \frac{-b \pm \sqrt{b^2 - 4ac}}{2a}

Task Lists

Create checkboxes using =item with :checked:

=for item :checked
Completed task
=for item :!checked
Pending task

Advanced Features

Table of Contents

Generate a table of contents using =toc:

=toc head1, head2, head3

Including Files

Include other files using =include:

=include file:chapter1.pod6

Custom Blocks

Create custom blocks by using mixed-case names:

=begin CustomBlock
This is a custom block that can be processed
by specialized renderers.
=end CustomBlock

Best Practices

Next Steps

Now that you've seen the basics, you can:

  • Read the full specification for complete details

  • Try creating your own Podlite documents

  • Explore more advanced features as needed