alcamo/markdown

Markdown generation and transformation

0.1.2 2026-07-10 18:22 UTC

Requires

• php: 7.3 - 8.5

Requires (Dev)

• phpunit/phpunit: ^9.5
• squizlabs/php_codesniffer: 3.*

Apache-2.0

• markdown
• transformation

Published on Packagist.org on 2026-07-10 18:22 UTC

README

use alcamo\markdown\MarkdownText;

include $_composer_autoload_path ?? __DIR__ . '/../vendor/autoload.php';

$markdown1 = MarkdownText::newFromText(
    'Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy '
        . 'eirmod tempor invidunt ut labore et dolore magna aliquyam erat, '
        . 'sed diam voluptua.',
    true
);

$markdown1->toBulletListItem();

$markdown2 = MarkdownText::newFromText('At vero eos:');

$markdown2->append(
    MarkdownText::newFromText('foo')->toOrderedListItem(1)
);

$markdown2->append(
    MarkdownText::newFromText('bar')->toOrderedListItem(2)
);

$markdown1->append($markdown2->toBulletListItem());

echo $markdown1->toQuote() . PHP_EOL;

This example is contained in this package as a file in the bin directory. It will output

> * Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam
>   nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
>   sed diam voluptua.
> * At vero eos:
>    1. foo
>    2. bar

The MarkdownText class is a simple container for markdown text. It does no kind of parsing or redering but has methods to transform text, in particular to prepend something to each line. As shown by the example, this may be particularly useful if existing markdown text is inserted as an item or quote into another text.

See the doxygen documentation for details.