submitty/markdown

A twig markdown extension

v23.12.00 2023-11-28 15:49 UTC

Requires

• php: ^7.4 || ^8.0
• league/commonmark: ^2.0.0
• twig/twig: ^2.7.0|^3.0

Requires (Dev)

• php: ^7.2.5|^8.0
• phpunit/phpunit: ~6.0|~5.0|~8.0

BSD-3-Clause

README

Twig-Markdown Extension

Forked from aptoma/twig-markdown

To report issues for Submitty/Markdown, please file them under the Submitty/Submitty repository.

Objectives

• Apply league/commonmark as an Twig Extension

Installation

{
    "repositories": [
    {
        "type": "vcs",
        "url": "https://github.com/Submitty/Markdown.git"
    }
    ],
    "require":{
        "league/commonmark": "2.4.0",
        "submitty/markdown": "version"
    }
}

composer install
# or
composer update

Example

use League\CommonMark\MarkdownConverter;

use Markdown\twig\Extension\PHPLeagueMarkdownEngine;
use Markdown\twig\Extension\MarkdownExtension;

// Based on the league/commonmark example
$config = [
    'allow_unsafe_links' => false,
];
$environment = new Environment($config);
$environment->addExtension(new CommonMarkCoreExtension());

$converter = new MarkdownConverter($environment);
$engine = new PHPLeagueMarkdownEngine($converter);

twig->addExtension(new MarkdownExtension($engine));

See Documentation

Documentation in Progress General Documentation