Podlite Quick Start Guide: Your 10-Minute Journey to Powerful Documentation

What Makes Podlite Special? (30 seconds)

Podlite is the only markup language that gives you:

  • **Markdown compatibility** - Use all your existing Markdown knowledge

  • **Advanced semantic blocks** - Structure complex documentation with precision

  • **Interactive elements** - Create dynamic, engaging documentation

  • **Extensible architecture** - Add custom blocks and markup codes

Your First Podlite Document (2 minutes)

Let's start with something familiar. Here's Markdown **inside** Podlite:

Now, let's add some Podlite magic:

=head1 Enhanced with Podlite

=begin nested :notify<note>
This notification block doesn't exist in pure Markdown, 
but it's seamlessly integrated here!
=end nested

=table
Name        | Role           | Superpower
============|================|=====================
Alice       | Developer      | Debugging telepathy
Bob         | Designer       | Perfect color vision  
Carol       | Manager        | Meeting time control

Progressive Examples (5 minutes)

Example 1: Basic Enhancement

Start with familiar Markdown syntax, then enhance it:

Example 2: Semantic Documentation

Perfect for technical documentation:

=NAME MyAwesomeProject

=SYNOPSIS
Z<>=begin code :lang<javascript>
import { MyAwesome } from 'my-awesome-project';
const project = new MyAwesome();
project.start();
Z<>=end code

=DESCRIPTION
This project demonstrates the power of structured documentation
with semantic blocks that tools can understand and process.

Example 3: Advanced Features

=begin table :caption<"Project Timeline">
=begin row :header
=cell Phase
=cell Duration  
=cell Status
=end row

=begin row
=cell Planning
=cell 2 weeks
=for cell :rowspan<2>
In Progress
=end row

=begin row  
=cell Development
=cell 6 weeks
=end row
=end table

=toc head1, head2, head3

=include file:shared-content.podlite | USAGE, EXAMPLES

Why Podlite Contains Markdown (Not Competes)

Here's the key insight: **There's no point comparing Podlite vs. Markdown** because Markdown is a **subset** of Podlite!

You can use pure Markdown whenever you want:

This entire section is written in Markdown syntax:

def demonstrate_markdown():
    """Pure Markdown works perfectly in Podlite"""
    return "No conversion needed!"

Bold, italic, and links all work exactly as expected.

When you need more power, just step outside the `=markdown` block:

Real-World Example: API Documentation

=NAME Weather API Client

=SYNOPSIS  
Z<>=begin code :lang<javascript>
const client = new WeatherAPI('your-api-key');
const weather = await client.getCurrentWeather('London');
Z<>=end code

=begin markdown
## Quick Start with Markdown

If you prefer Markdown for basic documentation:

```bash
npm install weather-api-client
```

### Basic Usage
- Import the client
- Add your API key  
- Make requests
=end markdown

=METHOD getCurrentWeather($city)

Returns current weather data for the specified city.

=begin table :caption<"Response Format">
Field       | Type    | Description
============|=========|================================  
temperature | Number  | Temperature in Celsius
humidity    | Number  | Humidity percentage (0-100)
conditions  | String  | Weather description
=end table

=begin nested :notify<warning>
**Rate Limiting**: This API allows 1000 requests per hour.
Use caching for production applications.
=end nested

Interactive Features

Next Steps (30 seconds)

You've just experienced the power of Podlite! Here's how to continue:

**Path** **Time** **Perfect For**
**Learn Syntax** 15 minutes Complete language reference
**Try Templates** 5 minutes Pre-built document structures
**Install Tools** 10 minutes VS Code plugin & CLI tools