https://github.com/veiliglanceren-nl/laravel-seo-sitemap
Laravel Sitemap package to optimize your website in search engines
https://github.com/veiliglanceren-nl/laravel-seo-sitemap
composer-package laravel laravel-12 laravel-12-package php8 seo sitemap sitemap-builder
Last synced: about 2 months ago
JSON representation
Laravel Sitemap package to optimize your website in search engines
- Host: GitHub
- URL: https://github.com/veiliglanceren-nl/laravel-seo-sitemap
- Owner: VeiligLanceren-nl
- License: mit
- Created: 2025-03-31T11:48:38.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2025-04-08T09:39:00.000Z (about 2 months ago)
- Last Synced: 2025-04-09T15:17:13.714Z (about 2 months ago)
- Topics: composer-package, laravel, laravel-12, laravel-12-package, php8, seo, sitemap, sitemap-builder
- Language: PHP
- Homepage: https://veiliglanceren.nl
- Size: 10.1 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
This package is maintained by VeiligLanceren.nl, your partner in website development and everything else to power up your online company. More information available on [our website](https://veiliglanceren.nl).
# Laravel SEO Sitemap
A lightweight and extensible sitemap generator for Laravel that supports automatic route discovery, custom URL entries, and XML generation — designed for SEO optimization.
## 🚀 Features
- Generate sitemaps from named Laravel routes using a macro: `->sitemap()`
- Customize URLs with `lastmod`, `priority`, `changefreq`
- Clean XML output with optional pretty-printing
- Store sitemaps to disk
- Artisan command to update `lastmod` for routes
- Fully tested with Pest and Laravel Testbench
- Default `/sitemap.xml` route that serves the configured sitemap location
---
## 📦 Installation
```bash
composer require veiliglanceren/laravel-seo-sitemap
```
---
## ⚙️ Configuration
If used outside Laravel auto-discovery, register the service provider:
```php
// bootstrap/providers.php
return [
VeiligLanceren\LaravelSeoSitemap\SitemapServiceProvider::class,
];
```
Publish the `config/sitemap.php` config file:
```bash
php artisan vendor:publish --tag=sitemap-config
```
Publish the migration (if using `lastmod` tracking):
```bash
php artisan vendor:publish --tag=sitemap-migration
php artisan migrate
```
---
## 🧭 Usage
- 📄 [Full Sitemap class documentation](docs/sitemap.md)
- 📄 [Url class documentation](docs/url.md)
- 📄 [Url image documentation](docs/image.md)
- 📄 [Sitemap Index documentation](docs/sitemapindex.md)
### Basic usage
```php
use VeiligLanceren\LaravelSeoSitemap\Support\Enums\ChangeFrequency;
Route::get('/contact', [ContactController::class, 'index'])
->name('contact') // 🔖 Sets the route name
->sitemap() // ✅ Include in sitemap
->changefreq(ChangeFrequency::WEEKLY) // ♻️ Update frequency: weekly
->priority('0.8'); // ⭐ Priority for search engines
```
```php
$sitemap = Sitemap::fromRoutes();
$sitemap->save('sitemap.xml', 'public');
```
### Static usage
```php
use VeiligLanceren\LaravelSeoSitemap\Sitemap\Item\Url;
use VeiligLanceren\LaravelSeoSitemap\Support\Enums\ChangeFrequency;
$url = Url::make('https://example.com')
->lastmod('2025-01-01')
->priority('0.8')
->changefreq(ChangeFrequency::WEEKLY);
$sitemap = Sitemap::make([$url]);
$sitemap->save('sitemap.xml', 'public');
```
---
### Sitemap index usage
```php
use VeiligLanceren\LaravelSeoSitemap\Sitemap\SitemapIndex;
$sitemapIndex = SitemapIndex::make([
'https://example.com/sitemap-posts.xml',
'https://example.com/sitemap-pages.xml',
]);
$sitemapIndex->toXml();
```
To save:
```php
Storage::disk('public')->put('sitemap.xml', $sitemapIndex->toXml());
```
### 🖼 Adding Images to URLs
You can attach one or more `` elements to a `Url` entry:
```php
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'));
```
These images will be embedded under the `` node in the generated XML:
```xml
https://example.com
https://example.com/image1.jpg
Hero 1
https://example.com/image2.jpg
Hero 2
```
Each `Image` supports optional fields: `caption`, `title`, `license`, and `geo_location`.
## Change frequencies
The package is providing an enum with the possible change frequencies as documented on [sitemaps.org](https://www.sitemaps.org/protocol.html#changefreqdef).
### Available frequencies
- `ChangeFrequency::ALWAYS`
- `ChangeFrequency::HOURLY`
- `ChangeFrequency::DAILY`
- `ChangeFrequency::WEEKLY`
- `ChangeFrequency::MONTHLY`
- `ChangeFrequency::YEARLY`
- `ChangeFrequency::NEVER`
## 🛠 Update `lastmod` via Artisan
```bash
php artisan url:update contact
```
This updates the `lastmod` timestamp for the route `contact` using the current time.
## Sitemap meta helper
Add the Sitemap URL to your meta data with the helper provided by the package. By default it will use the default `/sitemap.xml` URL.
```php
Your title
{{ sitemap_meta_tag($customUrl = null) }}
```
---
## ✅ Testing
Run tests using Pest:
```bash
vendor/bin/pest
```
Make sure you have SQLite enabled for in-memory testing.
---
## 📂 Folder Structure
- `src/` - Core sitemap logic
- `tests/` - Pest feature & unit tests
- `database/migrations/` - `url_metadata` tracking support
- `routes/` - Uses Laravel route inspection
- `docs/` - Extended documentation
---
## 📄 License
MIT © Veilig Lanceren