benfiratkaya/commonmark-ext-link-text-viewer

This extension provides support for changing the content of links to url for phpleague/commonmark markdown parser package.

1.0.1 2022-03-05 15:45 UTC

Requires

• php: ^7.4 || ^8.0
• league/commonmark: ^2.0

Requires (Dev)

• phpunit/phpunit: ^9.0

MIT

• Firat Kaya

• text
• markdown
• extension
• link
• commonmark

README

This extension provides support for changing the content of links to url for league/commonmark package version ^2.0.

Install

composer require benfiratkaya/commonmark-ext-link-text-viewer

Example

use League\CommonMark\Environment\Environment;
use League\CommonMark\Extension\CommonMark\CommonMarkCoreExtension;
use BenFiratKaya\CommonMarkExtension\LinkTextViewerExtension;

$environment = new Environment([]);
$environment->addExtension(new CommonMarkCoreExtension())
            ->addExtension(new LinkTextViewerExtension());

$converter = new MarkdownConverter($environment);
$html = $converter->convertToHtml('[text](http://example.test)');

This creates the following HTML

<a href="http://example.test">http://example.test</a>

Options

//...
$environment = new Environment([]);
$environment->addExtension(new CommonMarkCoreExtension())
            ->addExtension(new LinkTextViewerExtension());

$converter = new MarkdownConverter([
  'link_text_viewer' => [
      'internal_hosts' => '/(^|\.)internal\.test$/', // TODO: Don't forget to set this!
      'link_type' => 'all', // Set '' to disable. Variables: all, external, internal
  ],
], $environment)
$html = $converter->convertToHtml('[text](http://example.test)');

This creates the following HTML

<a href="http://example.test">http://example.test</a>