Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Statamic 5: Update "Installation" section to mention install:ssg command #161

Merged
merged 1 commit into from
Apr 16, 2024
Merged

Statamic 5: Update "Installation" section to mention install:ssg command #161

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 4 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,13 @@

## Installation

Install the package using Composer:
You can install the Static Site Generator package with the following command:

```
composer require statamic/ssg
php please install: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.
The command will install the `statamic/ssg` package via Composer, optionally publish the configuration file and prompt you if you wish to install the `spatie/fork` package for running [multiple workers](#multiple-workers).


## Usage
Expand All @@ -29,6 +23,7 @@ php please ssg:generate

Your site will be generated into a directory which you can deploy however you like. See [Deployment Examples](#deployment-examples) below for inspiration.


### Multiple Workers

For improved performance, you may spread the page generation across multiple workers. This requires Spatie's [Fork](https:/spatie/fork) package. Then you may specify how many workers are to be used. You can use as many workers as you have CPU cores.
Expand Down