ueberdosis/commonmark-hint-extension

A hint extension for league/commonmark

Maintainers

Details

github.com/ueberdosis/commonmark-hint-extension

Homepage

Source

Issues

Fund package maintenance!
ueberdosis/

Installs: 6 502

Dependents: 1

Suggesters: 0

Security: 0

Stars: 8

Watchers: 3

Forks: 3

Open Issues: 0

0.1.0 2021-08-26 11:50 UTC

Requires

Requires (Dev)

MIT 2f27c95862486f88730fd62a6b94a36a00b5149e

  • Hans Pagel <hans.pagel.woop@ueber.io>

markdowncommonmarkcommonmark-hint-extension

This package is auto-updated.

Last update: 2024-10-27 22:45:48 UTC

README

We need your support to maintain this package. 💖 https://github.com/sponsors/ueberdosis

CommonMark Hint Extension

Tests Sponsor

A hint extension for league/commonmark that renders the following Markdown as HTML.

Example

Markdown

:::important Warning!
This is how the **Markdown** looks.
:::

HTML

<div class="hint important">
    <h2 class="hint-title">
        Warning!
    </h2>
    <p class="hint-content">
        This is how the <strong>Markdown</strong> looks.
    </p>
</div>

Installation

You can install the package via composer:

composer require ueberdosis/commonmark-hint-extension

Usage

<?php

use League\CommonMark\Environment\Environment;
use League\CommonMark\Extension\CommonMark\CommonMarkCoreExtension;
use League\CommonMark\MarkdownConverter;
use Ueberdosis\CommonMark\HintExtension;

// Configure the Environment with all the CommonMark parsers/renderers
$environment = new Environment();
$environment->addExtension(new CommonMarkCoreExtension());

// Add this extension
$environment->addExtension(new HintExtension());

// Instantiate the converter engine and start converting some Markdown!
$converter = new MarkdownConverter($environment);
$markdown = <<<MARKDOWN
:::important Warning!
This is how the **Markdown** looks.
:::
MARKDOWN;

echo $converter->convertToHtml($markdown);

Testing

composer test

Credits

License

The MIT License (MIT). Please see License File for more information.