krishanujadiya/sitemap-generator

A Laravel package to generate sitemaps dynamically.

dev-main 2024-08-04 18:07 UTC

Requires

• php: ^7.3|^8.0
• laravel/framework: ^8.0|^9.0|^10.0|^11.0

MIT

• Krishanu Jadiya

README

A Laravel package to generate sitemaps dynamically.

Installation

You can install the package via Composer:

composer require krishanujadiya/sitemap-generator

Usage
Publish the configuration file:

php artisan vendor:publish --provider="krishanujadiya\\SitemapGenerator\\Providers\\SitemapServiceProvider"
Generate a sitemap by passing URLs from your controller:

use krishanujadiya\SitemapGenerator\SitemapGenerator;

class YourController extends Controller
{
    public function generateSitemap()
    {
        $urls = [
            ['url' => 'https://example.com/page1', 'lastmod' => '2023-01-01'],
            ['url' => 'https://example.com/page2', 'lastmod' => '2023-02-01']
        ];

        SitemapGenerator::create($urls);
    }
}
Example provided
Register a route to generate the sitemap:

In routes/web.php:

use krishanujadiya\SitemapGenerator\Http\Controllers\SitemapController;

Route::get('/generate-sitemap', [SitemapController::class, 'create']);
Generate the sitemap:

Access the /generate-sitemap URL and pass URLs as query parameters to generate the sitemap, which will be saved to the public disk.

Configuration
Edit the config/sitemap.php file to set changefreq and priority:

return [
    'changefreq' => env('SITEMAP_CHANGEFREQ', 'daily'),
    'priority' => env('SITEMAP_PRIORITY', '0.8'),
];
You can also set these variables in your .env file:

SITEMAP_CHANGEFREQ=daily
SITEMAP_PRIORITY=0.8