kijtkd/markdown-flex-php

Convert Markdown to LINE WORKS Bot Flexible Template

dev-main 2025-06-21 03:10 UTC

Requires

• php: ^8.1
• league/commonmark: ^2.4
• psr/simple-cache: ^3.0

Requires (Dev)

• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^10.0
• squizlabs/php_codesniffer: ^3.7

Suggests

• league/flysystem: For image upload abstraction (S3, etc.)

MIT

• Your Name

• markdown
• converter
• bot
• line-works
• flex-message

README

Convert Markdown to LINE WORKS Bot Flexible Template

Installation

composer require mdflex/markdown-flex-php

Usage

Basic Usage

<?php

use MdFlex\MarkdownFlexConverter;

$converter = new MarkdownFlexConverter();
[$json, $altText] = $converter->convert($markdown);

// Send to LINE WORKS Bot
$client->post('/messages', [
    'altText' => $altText,
    'content' => $json,
]);

With Theme

use MdFlex\MarkdownFlexConverter;
use MdFlex\Theme\DarkTheme;

$converter = (new MarkdownFlexConverter())
    ->setTheme(new DarkTheme());

[$json, $altText] = $converter->convert($markdown);

With Options

$converter = (new MarkdownFlexConverter())
    ->setOptions([
        'code_img'  => true,  // Convert code blocks to images
        'max_lines' => 18,    // Max lines per bubble
    ]);

[$json, $altText] = $converter->convert($markdown);

Features

• Automatic Size Management: Automatically handles LINE WORKS Bubble (10KB) and Carousel (50KB) size limits
• Text Truncation: Automatically truncates text to 2,000 characters and altText to 400 characters
• Theme Support: Customizable themes for different visual styles
• Markdown Support: Supports headings, paragraphs, lists, code blocks, blockquotes, images, and basic formatting
• UTF-8 Safe: Proper handling of multibyte characters

Supported Markdown Elements

Markdown Element	Flex Component	Notes
# Heading	text	Sizes: xxl, xl, lg, md, sm, xs
Paragraph	text	With text wrapping
- List item	box + text	With bullet points
	image	Aspect ratio 20:13
`code`	text	Monospace styling
> Quote	box	With background color

LINE WORKS Limitations

The library automatically handles these LINE WORKS limitations:

• Bubble Size: ≤ 10KB (automatically splits into multiple bubbles)
• Text Length: ≤ 2,000 characters (automatically truncates)
• AltText Length: ≤ 400 characters (automatically truncates)
• Carousel: ≤ 10 bubbles and ≤ 50KB total

Requirements

• PHP 8.1+
• league/commonmark ^2.4
• psr/simple-cache ^3.0

Testing

composer test
composer phpstan
composer cs

License

MIT License - see LICENSE file for details.