README

CommonMark Rewrite Local Image URLs Extension

CommonMark extension for rewriting local, relative image URLs to absolute URLs.

Requirements

• PHP
  • league/commonmark

Installation

Install the extension with Composer.

composer require phlak/commonmark-rewrite-local-image-urls

Then add the extension to your CommonMark environment.

use League\CommonMark\Environment\Environment;
use League\CommonMark\Extension\CommonMark\CommonMarkCoreExtension;
use League\CommonMark\MarkdownConverter;
use PHLAK\CommonMarkExtensions\RewriteLocalImageURLs;

$environment = new Environment;
$environment->addExtension(new CommonMarkCoreExtension);
$environment->addExtension(new RewriteLocalImageURLs('https://example.com'));

$converter = new MarkdownConverter($environment);

Usage

When converting Markdown, any local, relative image URL will be rewritten to an absolute URL using the configured base URL.

$converter->convert('![alt text](image.png)');
// Returns: <p><img src="https://example.com/image.png" alt="alt text" /></p>

$converter->convert('![alt text](/image.png)');
// Returns: <p><img src="https://example.com/image.png" alt="alt text" /></p>

$converter->convert('![alt text](assets/images/photo.jpg)');
// Returns: <p><img src="https://example.com/assets/images/photo.jpg" alt="alt text" /></p>

External image URLs are left unchanged.

$converter->convert('![alt text](https://external.com/image.png)');
// Returns: <p><img src="https://external.com/image.png" alt="alt text" /></p>

$converter->convert('![alt text](//external.com/image.png)');
// Returns: <p><img src="//external.com/image.png" alt="alt text" /></p>

Changelog

A list of changes can be found on the GitHub Releases page.

Troubleshooting

For general help and support join our GitHub Discussion or reach out on Bluesky.

Please report bugs to the GitHub Issue Tracker.

Copyright

This project is licensed under the MIT License.