.
*/
declare(strict_types=1);
namespace Fisharebest\Webtrees\Factories;
use Fisharebest\Webtrees\CommonMark\CensusTableExtension;
use Fisharebest\Webtrees\CommonMark\XrefExtension;
use Fisharebest\Webtrees\Contracts\MarkdownFactoryInterface;
use Fisharebest\Webtrees\Tree;
use League\CommonMark\Environment\Environment;
use League\CommonMark\Extension\Autolink\AutolinkExtension;
use League\CommonMark\Extension\CommonMark\CommonMarkCoreExtension;
use League\CommonMark\Extension\CommonMark\Node\Inline\Link;
use League\CommonMark\Extension\CommonMark\Renderer\Inline\LinkRenderer;
use League\CommonMark\Extension\Table\TableExtension;
use League\CommonMark\MarkdownConverter;
use League\CommonMark\Node\Block\Document;
use League\CommonMark\Node\Block\Paragraph;
use League\CommonMark\Node\Inline\Newline;
use League\CommonMark\Node\Inline\Text;
use League\CommonMark\Parser\Inline\NewlineParser;
use League\CommonMark\Renderer\Block\DocumentRenderer;
use League\CommonMark\Renderer\Block\ParagraphRenderer;
use League\CommonMark\Renderer\Inline\NewlineRenderer;
use League\CommonMark\Renderer\Inline\TextRenderer;
use League\CommonMark\Util\HtmlFilter;
use function strip_tags;
use function strtr;
use function trim;
/**
* Create a markdown converter.
*/
class MarkdownFactory implements MarkdownFactoryInterface
{
public const BREAK = '
';
// Commonmark uses
for hard-breaks, so we use the same for soft-breaks.
protected const CONFIG_AUTOLINK = [
'allow_unsafe_links' => false,
'html_input' => HtmlFilter::ESCAPE,
'renderer' => [
'soft_break' => self::BREAK,
],
];
protected const CONFIG_MARKDOWN = [
'allow_unsafe_links' => false,
'html_input' => HtmlFilter::ESCAPE,
'renderer' => [
'soft_break' => self::BREAK,
],
'table' => [
'wrap' => [
'enabled' => true,
'tag' => 'div',
'attributes' => [
'class' => 'table-responsive',
],
],
],
];
/**
* @param string $markdown
* @param Tree|null $tree
*
* @return string
*/
public function autolink(string $markdown, Tree $tree = null): string
{
// Create a minimal commonmark processor - just add support for auto-links.
$environment = new Environment(static::CONFIG_AUTOLINK);
$environment->addInlineParser(new NewlineParser());
$environment->addRenderer(Document::class, new DocumentRenderer());
$environment->addRenderer(Paragraph::class, new ParagraphRenderer());
$environment->addRenderer(Text::class, new TextRenderer());
$environment->addRenderer(Link::class, new LinkRenderer());
$environment->addRenderer(Newline::class, new NewlineRenderer());
$environment->addExtension(new AutolinkExtension());
// Optionally create links to other records.
if ($tree instanceof Tree) {
$environment->addExtension(new XrefExtension($tree));
}
$converter = new MarkDownConverter($environment);
$html = $converter->convert($markdown)->getContent();
$html = strtr($html, ["\n" => self::BREAK . self::BREAK]);
return trim(strip_tags($html, ['a', 'br']));
}
/**
* @param string $markdown
* @param Tree|null $tree
*
* @return string
*/
public function markdown(string $markdown, Tree $tree = null): string
{
$environment = new Environment(static::CONFIG_MARKDOWN);
$environment->addExtension(new CommonMarkCoreExtension());
$environment->addExtension(new TableExtension());
// Convert webtrees 1.x style census tables to commonmark format.
$environment->addExtension(new CensusTableExtension());
// Optionally create links to other records.
if ($tree instanceof Tree) {
$environment->addExtension(new XrefExtension($tree));
}
$converter = new MarkDownConverter($environment);
return $converter->convert($markdown)->getContent();
}
}