# Use Laravel URL Helpers inside Markdown
**Package:** CommonMark Routes | **Version:** 1 | **URL:** https://mozex.dev/docs/commonmark-routes/v1
---
A [league/commonmark](https://github.com/thephpleague/commonmark) extension that lets you use `route()`, `url()`, and `asset()` inside your Markdown content. Write links and images using the same Laravel helpers you already use in Blade, and they'll resolve to real URLs when the Markdown is converted.
> **Warning:** This extension evaluates helper calls from the Markdown source. Only use it with trusted content that you control. Don't process user-submitted Markdown with this extension.
## Installation
> **Requires [PHP 8.2+](https://php.net/releases/)**
Install the package via Composer:
```bash
composer require mozex/commonmark-routes
```
## Usage
Register the extension with your CommonMark environment, then use `route()`, `url()`, or `asset()` in place of URLs in your Markdown.
```php
use League\CommonMark\CommonMarkConverter;
use Mozex\CommonMarkRoutes\RoutesExtension;
$converter = new CommonMarkConverter();
$converter->getEnvironment()->addExtension(new RoutesExtension());
```
### Links
The `route()` helper works exactly the way it does in your PHP code. Named routes, parameters, query strings, relative URLs:
```php
echo $converter->convert("[Home](route('home'))");
// Home
echo $converter->convert("[Product](route('product', 3))");
// Product
echo $converter->convert("[Features](route('home', ['id' => 'features']))");
// Features
echo $converter->convert("[Home](route('home', absolute: false))");
// Home
```
The `url()` helper generates URLs from plain paths:
```php
echo $converter->convert("[About](url('about'))");
// About
echo $converter->convert("[Docs](url('docs/getting-started'))");
// Docs
```
The `asset()` helper resolves static file paths through Laravel's asset pipeline. This is especially useful on environments like [Laravel Vapor](https://vapor.laravel.com) where assets are served from S3 or CloudFront and relative paths won't work:
```php
echo $converter->convert("[Download PDF](asset('files/doc.pdf'))");
// Download PDF
```
When the helper is used as both the link text and the URL, the resolved URL appears in both places:
```php
echo $converter->convert("[route('home')](route('home'))");
// https://domain.com
```
Angle brackets work too, which can help with complex arguments:
```php
echo $converter->convert("[Home]()");
// Home
```
You can freely mix helpers with regular Markdown links in the same document:
```php
echo $converter->convert("[Home](route('home')) | [Docs](url('docs')) | [Google](https://google.com)");
// Home | Docs | Google
```
### Images
Image syntax works the same way. Put a helper inside `` and it resolves just like links do:
```php
echo $converter->convert(")");
// 
echo $converter->convert(")");
// 
echo $converter->convert(")");
// 
```
The `asset()` helper is the most common choice for images. If you're on Vapor or any setup that serves assets from a CDN, `asset()` gives you the correct absolute URL instead of a broken relative path.
Regular images without helpers pass through untouched:
```php
echo $converter->convert("");
// 
```
For more details on CommonMark extensions and environments, check the [CommonMark documentation](https://commonmark.thephpleague.com/2.4/basic-usage/).
### Spatie Laravel Markdown
If you're using the [Laravel Markdown](https://github.com/spatie/laravel-markdown/) package by Spatie, register the extension in `config/markdown.php`:
```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,
],
```
---
## Table of Contents
- [Quick Start](https://mozex.dev/docs/commonmark-routes/v1)
- [Support Us](https://mozex.dev/docs/commonmark-routes/v1/support-us)
- [Requirements](https://mozex.dev/docs/commonmark-routes/v1/requirements)
- [Changelog](https://mozex.dev/docs/commonmark-routes/v1/changelog)
- [Contributing](https://mozex.dev/docs/commonmark-routes/v1/contributing)
- [Questions & Issues](https://mozex.dev/docs/commonmark-routes/v1/questions-and-issues)
- [About Mozex](https://mozex.dev/docs/commonmark-routes/v1/about)