mozex/commonmark-routes

Laravel routes in Markdown: A CommonMark extension to seamlessly use Laravel route functions within your Markdown content.

1.1.0 2024-06-28 16:22 UTC

Requires

• php: ^8.1
• illuminate/contracts: ^10.0|^11.0
• league/commonmark: ^2.4
• spatie/laravel-package-tools: ^1.16

Requires (Dev)

• larastan/larastan: ^2.0.1
• laravel/pint: ^1.13.6
• nunomaduro/collision: ^7.8|^8.1
• orchestra/testbench: ^8.21|^9.0
• pestphp/pest: ^2.34
• phpstan/extension-installer: ^1.1
• phpstan/phpstan-deprecation-rules: ^1.0
• phpstan/phpstan-phpunit: ^1.0
• spatie/laravel-ray: ^1.26

MIT

• Mozex

• php
• markdown
• routes
• laravel
• commmonmark
• commonmark-routes

README

An extension for league/commonmark that allows you to use Laravel routes inside markdown, just as you would in your PHP code.

Warning: This extension is intended for use in controlled environments where the markdown is trusted. Do not use this extension for processing user-input markdown due to potential security risks.

Table of Contents

• Support Us
• Installation
• Usage
  • Basic Usage
  • Spatie Laravel Markdown
• Testing
• Changelog
• Contributing
• Security Vulnerabilities
• Credits
• License

Support us

Creating and maintaining open-source projects requires significant time and effort. Your support will help enhance the project and enable further contributions to the PHP community.

Sponsorship can be made through the GitHub Sponsors program. Just click the "Sponsor" button at the top of this repository. Any amount is greatly appreciated, even a contribution as small as $1 can make a big difference and will go directly towards developing and improving this package.

Thank you for considering sponsoring. Your support truly makes a difference!

Installation

Requires PHP 8.1+

You can install the package via composer:

composer require mozex/commonmark-routes

Usage

Register RoutesExtension as a CommonMark extension and use the route function instead of URLs in your markdown, just as you would in your PHP code.

use League\CommonMark\Environment\Environment;
use League\CommonMark\CommonMarkConverter;
use Mozex\CommonMarkRoutes\RoutesExtension;

$converter = new CommonMarkConverter($environment);
$converter->getEnvironment()->addExtension(new RoutesExtension());

echo $converter->convert("[Home](route('home'))");
// Output: <p><a href="https://domain.com">Home</a></p>

echo $converter->convert("[Home](<route('home')>)");
// Output: <p><a href="https://domain.com">Home</a></p>

echo $converter->convert("[Home](route('home', absolute: false))");
// Output: <p><a href="/">Home</a></p>

echo $converter->convert("[Product](route('product', 3))");
// Output: <p><a href="https://domain.com/product/3">Product</a></p>

echo $converter->convert("[Features](route('home', ['id' => 'features']))");
// Output: <p><a href="https://domain.com?id=features">Features</a></p>

echo $converter->convert("[Features](route('home', ['id' => 'features'], false))");
// Output: <p><a href="/?id=features">Features</a></p>

For more information on CommonMark extensions and environments, refer to the CommonMark documentation.

Spatie Laravel Markdown

When using the Laravel Markdown package, you may register the extension in config/markdown.php:

/*
 * These extensions should be added to the markdown environment. A valid
 * extension implements League\CommonMark\Extension\ExtensionInterface
 *
 * More info: https://commonmark.thephpleague.com/2.4/extensions/overview/
 */
'extensions' => [
    Mozex\CommonMarkRoutes\RoutesExtension::class,
],

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Mozex
• All Contributors

License

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