Generate static sites with Statamic 3.

No license is required during the Statamic 3 beta period.

Install the package using Composer:

composer require statamic/ssg

If you want or need to customize the way the site is generated, you can do so by publishing and modifying the config file with the following command:

php artisan vendor:publish --provider="Statamic\StaticSite\ServiceProvider"

The config file will be in config/statamic/ssg.php. This is optional and you can do it anytime.

Run the following command:

php please ssg:generate

Your site will be generated into a directory which you can deploy however you like. See Deployment Examples below for inspiration.

Routes will not automatically be generated. You can add any additional URLs you wish to be generated by adding them to the urls array in the config file.

'urls' => [
    '/this-route',
    '/that-route',
],

You may optionally define extra steps to be executed after the site has been generated.

use Statamic\StaticSite\Generator;

class AppServiceProvider extends Provider
{
    public function boot()
    {
        Generator::after(function () {
            // eg. copy directory to some server
        });
    }
}

These examples assumes your workflow will be to author content locally and not using the control panel in production.

Deployments are triggered by committing to Git and pushing to GitHub.

• Create a site in your Netlify account
• Link the site to your GitHub repository
• Add build command php please ssg:generate
• Set publish directory storage/app/static
• Add environment variable: PHP_VERSION 7.2

After your site has an APP_URL...

• Set it as an environment variable. Add APP_URL https://thats-numberwang-47392.netlify.com

If you are storing your assets in an S3 bucket, the .envs used will need to be different to the defaults that come with Laravel, as they are reserved by Netlify. For example, you can amend them to the following:

# .env
AWS_S3_ACCESS_KEY_ID=
AWS_S3_SECRET_ACCESS_KEY=
AWS_S3_DEFAULT_REGION=
AWS_S3_BUCKET=
AWS_URL=

Be sure to also update these in your s3 disk configuration:

        // config/filesystems.php
        's3' => [
            'driver' => 's3',
            'key' => env('AWS_S3_ACCESS_KEY_ID'),
            'secret' => env('AWS_S3_SECRET_ACCESS_KEY'),
            'region' => env('AWS_S3_DEFAULT_REGION'),
            'bucket' => env('AWS_S3_BUCKET'),
            'url' => env('AWS_URL'),
        ],

Prerequisite: Install with npm install --global surge. Your first deployment will involve creating an account via command line.

• Build with command php please ssg:generate
• Deploy with surge storage/app/static

Prerequisite: Follow the instructions to get started with Firebase hosting

• Once hosting is set up, make sure the public config in your firebase.json is set to storage/app/static
• (Optionally) Add a predeploy config to run php please ssg:generate
• Run firebase deploy