laravel-export

Create a static site bundle from a Laravel app

$ php artisan export
Exporting site...
Files were saved to disk `export`

Build your blog or site with Laravel like with the tools you're used to having and export it to be hosted statically.

Laravel Export will scan your app and create an HTML page from every URL it crawls. The entire public directory also gets added to the bundle so your assets are in place too.

A few example use cases for this package:

• Build your own blog or site in Laravel with all the tools you're used to using. Export a static version and just upload it anywhere for hosting, no need for managing a full-blown server anymore.

• Use something like Nova, Wink, Filament, Sharp, or any other admin panel to manage your site locally or on a remote server, then publish it to a service like Netlify. This gives you all benefits of a static site (speed, simple hosting, scalability) while still having a dynamic backend of some sort.

Support us

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.

Installation

You can install the package via composer:

composer require spatie/laravel-export

After the package is installed, you can optionally publish the config file.

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

Configuration

Laravel Export doesn't require configuration to get started, but there are a few things you can tweak to your needs.

// config/export.php

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

This means you can also use other filesystem drivers, so you could export your site straight to something like S3.

Determining the export contents

Crawling

With the default configuration, Laravel Export will crawl your site and export every page to a static site. If you'd like to disable this behaviour, disable the crawl option.

return [
    'crawl' => true,
];

By default, streaming is disabled. Enable the use_streaming option to reduce memory usage when crawling large sites. This option only makes sense when the crawl option is enabled.

return [
    'use_streaming' => true,
];

Paths

paths is an array of URL paths that will be exported to HTML. Use this to manually determine which pages should be exported.

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

Including files

include_files allows you to specify files and folders relative to the application root that should be added to the export. By default, we'll include the entire public folder.

return [
    'include_files' => [
        'public' => '',
    ],
];

exclude_file_patterns will check all source paths of included files, and exclude them if they match a pattern from in exclude_file_patterns. By default, all PHP files will be excluded, mainly to stop index.php from appearing in your export. Because the mix-manifest.json is no longer needed after compilation it is also excluded by default.

return [
    'exclude_file_patterns' => [
        '/\.php$/',
        '/mix-manifest\.json$/',
    ],
];

Configuration through code

All configuration options that affect the exports contents are also exposed in the Exporter class. You can inject this class to modify the export settings through code.

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'));
    }
}

Custom disks

By default, Laravel Export will save the static bundle in a dist folder in your application root. If you want to store the site in a different folder, configure a new disk in config/filesystem.php.

// config/filesystem.php

return [
    'disks' => [
        //

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

Hooks

before and after hooks allow you to do things before or after an export. Hooks can contain any shell command.

The default configuration doesn't have any hooks configured, but shows two examples.

With this before hook, we'll use Yarn to build our assets before every export:

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

With this after hook, we'll deploy the static bundle to Netlify with their CLI tool after the export.

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

If you want to run an export without certain hooks, use --skip-{hook} flags.

php artisan export --skip-deploy

To skip before, after and all hooks use the --skip-before, --skip-after, --skip-all flags respectively.

php artisan export --skip-before

php artisan export --skip-after

php artisan export --skip-all

Usage

To build a bundle, run the export command:

php artisan export

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Upgrading

Please see UPGRADING for more information on how to upgrade to a new version.

Contributing

Please see CONTRIBUTING for details.

Security

If you've found a bug regarding security please mail [email protected] instead of using the issue tracker.

Postcardware

You're free to use this package, but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.

Our address is: Spatie, Kruikstraat 22, 2018 Antwerp, Belgium.

We publish all received postcards on our company website.

Credits

• Sebastian De Deyne
• All Contributors

License

The MIT License (MIT). Please see License File for more information.