README

This package is maintained by VeiligLanceren.nl, your partner in website development and everything else to power up your online company.

Laravel SEO Sitemap

A lightweight and extensible sitemap generator for Laravel that supports automatic route discovery, dynamic and static URL entries, and XML generation — designed for SEO optimization.

🚀 Features

🔍 Automatic sitemap generation from named routes via ->sitemap() macro
🧩 Model dynamic route support via ->sitemapUsing(Model::class) macro
🔁 Template dynamic route support via ->sitemapUsing(SitemapItemTemplate::class) macro
📦 Dynamic route support via ->dynamic() macro
✏️ Customize entries with lastmod, priority, changefreq
🧼 Clean and compliant XML output
💾 Store sitemaps to disk or serve via route
🛠 Artisan command for lastmod updates
✅ Fully tested using Pest and Laravel Testbench
🌐 Default /sitemap.xml route included

📦 Installation

composer require veiliglanceren/laravel-seo-sitemap

Run the installer to publish the route stub and wire it into routes/web.php:

php artisan sitemap:install

⚙️ Configuration

If you're not using Laravel package auto-discovery, register the provider manually:

// bootstrap/providers.php
return [
    VeiligLanceren\LaravelSeoSitemap\SitemapServiceProvider::class,
];

Then publish the config file:

php artisan vendor:publish --tag=sitemap-config

And optionally publish & run the migration:

php artisan vendor:publish --tag=sitemap-migration
php artisan migrate

🧭 Usage

📄 Static Route

use VeiligLanceren\LaravelSeoSitemap\Support\Enums\ChangeFrequency;

Route::get('/contact', [ContactController::class, 'index'])
    ->name('contact')
    ->sitemap()
    ->changefreq(ChangeFrequency::WEEKLY)
    ->priority('0.8');

🧩 Template / Model Driven Route

use App\Sitemap\ItemTemplates\PostTemplate;

Route::get('/blog/{slug}', BlogController::class)
    ->name('blog.show')
    ->sitemapUsing(PostTemplate::class);

You may also point directly to an Eloquent model. The package will iterate over all() and generate URLs for each model instance:

Route::get('/product/{product}', ProductController::class)
    ->name('product.show')
    ->sitemapUsing(\App\Models\Product::class);

🔄 Dynamic Route

use VeiligLanceren\Sitemap\Dynamic\StaticDynamicRoute;
use VeiligLanceren\Sitemap\Dynamic\DynamicRouteChild;

Route::get('/blog/{slug}', BlogController::class)
    ->name('blog.show')
    ->dynamic(fn () => new StaticDynamicRoute([
        DynamicRouteChild::make(['slug' => 'first-post']),
        DynamicRouteChild::make(['slug' => 'second-post']),
    ]));

Generate Sitemap from Routes

php artisan sitemap:generate

Or via code:

use VeiligLanceren\LaravelSeoSitemap\Facades\Sitemap;

$sitemap = Sitemap::fromRoutes()->getSitemap();
$sitemap->save('sitemap.xml', 'public');

Sitemap::fromRoutes() returns a VeiligLanceren\LaravelSeoSitemap\Sitemap\Sitemap containing the object data of the sitemap.

🖼 Add Images to URLs

use VeiligLanceren\LaravelSeoSitemap\Sitemap\Item\Url;
use VeiligLanceren\LaravelSeoSitemap\Sitemap\Item\Image;

$url = Url::make('https://example.com')
    ->addImage(Image::make('https://example.com/image1.jpg')->title('Hero 1'))
    ->addImage(Image::make('https://example.com/image2.jpg')->title('Hero 2'));

🗂 Sitemap Index Support

use VeiligLanceren\LaravelSeoSitemap\Sitemap\SitemapIndex;

$sitemapIndex = SitemapIndex::make([
    'https://example.com/sitemap-posts.xml',
    'https://example.com/sitemap-pages.xml',
]);

Storage::disk('public')->put('sitemap.xml', $sitemapIndex->toXml());

🔁 Change Frequencies

Use ChangeFrequency enum values:

ALWAYS
HOURLY
DAILY
WEEKLY
MONTHLY
YEARLY
NEVER

->changefreq(ChangeFrequency::WEEKLY)

🛠 Update lastmod

php artisan url:update contact

This sets the lastmod for the route to the current timestamp.

🔗 Meta Tag Helper

<head>
    {!! Sitemap::meta() !!}
</head>

Outputs:

<link rel="sitemap" type="application/xml" title="Sitemap" href="/sitemap.xml" />

🧪 Testing

vendor/bin/pest

SQLite must be enabled for in-memory testing.

📚 Documentation

📂 Folder Structure

src/ – Core sitemap logic
tests/ – Pest feature & unit tests
docs/ – Documentation
routes/ – Laravel route macros
database/ – Optional migrations

veiliglanceren / laravel-seo-sitemap

Maintainers

Details