weph/commonmark-section-extension

0.1.0 2023-02-06 18:15 UTC

Requires

• php: ^8.1
• league/commonmark: ^2.3

Requires (Dev)

• phpunit/phpunit: ^10.0
• roave/security-advisories: dev-latest
• vimeo/psalm: ^5.6

MIT

• Philip Weinke

README

This league/commonmark extension wraps headings and associated content into sections.

Installation & Basic Usage

composer require weph/commonmark-section-extension

Example:

use League\CommonMark\Environment\Environment;
use League\CommonMark\Extension\CommonMark\CommonMarkCoreExtension;
use League\CommonMark\MarkdownConverter;
use Weph\CommonMark\SectionExtension;

$environment = new Environment();
$environment->addExtension(new CommonMarkCoreExtension());
$environment->addExtension(new SectionExtension());

$converter = new MarkdownConverter($environment);

echo $converter->convert(<<<EOMD
# Title

## Section 1

Section 1 content

### Section 1.1

Section 1.1 content

## Section 2

Section 2 content
EOMD
);

Output:

<section>
    <h1>Title</h1>
    <section>
        <h2>Section 1</h2>
        <p>Section 1 content</p>
        <section>
            <h3>Section 1.1</h3>
            <p>Section 1.1 content</p>
        </section>
    </section>
    <section>
        <h2>Section 2</h2>
        <p>Section 2 content</p>
    </section>
</section>