Laravel Export

After installation, you can optionally publish the configuration file to config/export.php to customize the export behavior.

php artisan vendor:publish --provider=Spatie\\Export\\ExportServiceProvider

When upgrading to version 1.4, note the following breaking changes and new features:

• PHP Requirement: The minimum supported PHP version is now 8.4.
• Dependency Update: The package now uses spatie/crawler ^9.1.
• API Changes: The LocalClient signature has changed. It is now an invokable class used as a Guzzle handler. If you extend or use LocalClient directly, you must update your implementation.

Version 1.4 supports response streaming via spatie/crawler ^9.1. For large sites, enabling streaming can help reduce memory consumption during the export process. This feature is disabled by default to maintain backward compatibility.

'use_streaming' => true,

Install the package via Composer to begin creating static site bundles from your Laravel application.

composer require spatie/laravel-export

By default, Laravel Export saves the bundle to a dist folder in your application root. You can change this by specifying a different filesystem disk in config/export.php. To use a custom location or driver (like S3), first define the disk in config/filesystem.php and then reference it in config/export.php.

// config/export.php

return [
    'disk' => 'export',
];

// config/filesystem.php

return [
    'disks' => [
        'export' => [
            'driver' => 'local',
            'root' => base_path('out'),
        ],
    ],
];

Laravel Export can automatically crawl your site to find pages. You can control this behavior and optimize memory usage for large sites via the configuration file.

return [
    // Enable or disable automatic crawling
    'crawl' => true,

    // Enable streaming to reduce memory usage when crawling large sites (only works if 'crawl' is true)
    'use_streaming' => true,
];

If you do not want to use crawling, or want to supplement it, you can provide an array of specific URL paths to be exported to HTML using the paths key.

return [
    'paths' => [
        '/',
        '/rss.xml',
    ],
];

Hooks allow you to execute shell commands before or after the export process. This is useful for building assets (e.g., via Yarn) or deploying the bundle (e.g., via Netlify CLI).

return [
    // Run before export
    'before' => [
        'assets' => '/usr/local/bin/yarn production',
    ],

    // Run after export
    'after' => [
        'deploy' => '/usr/local/bin/netlify deploy --prod',
    ],
];

Use include_files to specify files or folders (relative to the app root) to include in the bundle. Use exclude_file_patterns to exclude files based on regex patterns (e.g., excluding .php files or specific JSON files).

return [
    // Include specific folders/files
    'include_files' => [
        'public' => '',
    ],

    // Exclude files matching these patterns
    'exclude_file_patterns' => [
        '/\.php$/',
        '/mix-manifest\.json$/',
    ],
];

You can inject the Spatie\Export\Exporter class into a Service Provider to dynamically configure export settings at runtime.

use Illuminate\Support\ServiceProvider;
use Spatie\Export\Exporter;

class AppServiceProvider extends ServiceProvider
{
    public function boot(Exporter $exporter)
    {
        $exporter->crawl(false);
        $exporter->useStreaming(true);

        $exporter->paths(['', 'about', 'contact', 'posts']);
        $exporter->paths(Post::all()->pluck('slug'));
    }
}

To generate the static bundle, run the export Artisan command. You can skip specific hooks or all hooks using CLI flags.

# Standard export
php artisan export

# Skip a specific hook (e.g., 'deploy' from the config)
php artisan export --skip-deploy

# Skip before, after, or all hooks
php artisan export --skip-before
php artisan export --skip-after
php artisan export --skip-all