Skip to content

Commit

Permalink
Fix docs [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
aarondfrancis committed May 31, 2021
1 parent 9f8f137 commit dd4aef6
Show file tree
Hide file tree
Showing 7 changed files with 18 additions and 18 deletions.
2 changes: 1 addition & 1 deletion docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The `outputs` section of the config file defines which files are generated as th

**Anything that is generated as a result of your build process should be included here.**

config/airdrop.php{.filename}
config/airdrop.php {.filename}
```php
[
// ...
Expand Down
4 changes: 2 additions & 2 deletions docs/drivers/custom.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ If the [Filesystem](/drivers/filesystem) Driver isn't quite right for you, you c

Your custom driver must extend the Hammerstone `BaseDriver`.

CustomDriver.php{.filename}
CustomDriver.php {.filename}
```php
use Hammerstone\Airdrop\Drivers\BaseDriver;

Expand Down Expand Up @@ -35,7 +35,7 @@ The current hash will be available as a class property `$hash`, and the config f

To enable your driver, you'll need to add it to the `drivers` array in `airdrop.php`.

config/airdrop.php{.filename}
config/airdrop.php {.filename}
```php
'drivers' => [
'custom' => [
Expand Down
2 changes: 1 addition & 1 deletion docs/drivers/filesystem.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The Filesystem Driver is the default driver that we ship with. It stores all of

If you'd like to change the configuration, you can do so in `airdrop.php`.

config/airdrop.php{.filename}
config/airdrop.php {.filename}
```php
[
'drivers' => [
Expand Down
6 changes: 3 additions & 3 deletions docs/drivers/github.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ When using the GitHub driver, there is _no need_ for a remote disk anywhere. Ins

The GitHub driver is an extension of the Filesystem driver so much of the configuration is the same, although fewer items are needed.

config/airdrop.php{.filename}
config/airdrop.php {.filename}
```php
[
'drivers' => [
Expand Down Expand Up @@ -39,7 +39,7 @@ There are a couple steps you'll need to add to your GitHub Workflow to take adva

The first step is to calculate the hash of the inputs and save it in the environment for the cache step to use:

.github/workflows/deploy.yml{.filename}
.github/workflows/deploy.yml {.filename}
```yaml
- name: Generate Airdrop Hash
run: echo "AIRDROP_HASH=$(php artisan airdrop:hash)" >> $GITHUB_ENV
Expand All @@ -49,7 +49,7 @@ This command is going to run `php artisan airdrop:hash` to calculate the hash of

The next step you'll need to add is the cache step:

.github/workflows/deploy.yml{.filename}
.github/workflows/deploy.yml {.filename}
```yaml
- name: Generate Airdrop Hash
run: echo "AIRDROP_HASH=$(php artisan airdrop:hash)" >> $GITHUB_ENV
Expand Down
4 changes: 2 additions & 2 deletions docs/triggers/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The Config Trigger is extremely straightforward: it tells Airdrop to rebuild ass

By default we populate it with your `APP_ENV` which will keep your development, testing, and production asset builds separate.

config/airdrop.php{.filename}
config/airdrop.php {.filename}
```php
/*
* Trigger a rebuild when anything in this configuration array
Expand All @@ -22,7 +22,7 @@ You're free to add as many other values as you like.

You can inspect the `ConfigTrigger.php` class to see how simple it really is, it just returns the config from your `airdrop.php`.

ConfigTrigger.php{.filename}
ConfigTrigger.php {.filename}
```php
class ConfigTrigger implements TriggerContract
{
Expand Down
8 changes: 4 additions & 4 deletions docs/triggers/custom.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Let's imagine we want to trigger an asset rebuild any time the week of the year

Your custom trigger class must implement the Hammerstone `TriggerContract`.

WeekTrigger.php{.filename}
WeekTrigger.php {.filename}
```php
use Hammerstone\Airdrop\Contracts\TriggerContract;

Expand All @@ -32,7 +32,7 @@ With that contract, you'll be forced to implement a method `triggerBuildWhenChan

In our case, we just want to return the week of the year, so we'll ignore that config.

WeekTrigger.php{.filename}
WeekTrigger.php {.filename}
```php
use Hammerstone\Airdrop\Contracts\TriggerContract;

Expand All @@ -56,7 +56,7 @@ class WeekTrigger implements TriggerContract

To enable your trigger, you'll need to add it to `airdrop.php`. Since no config is required in this example you don't need to pass an empty array, you can just use the class name.

config/airdrop.php{.filename}
config/airdrop.php {.filename}
```php
'triggers' => [
ConfigTrigger::class => [
Expand All @@ -74,7 +74,7 @@ config/airdrop.php{.filename}

If you wanted to have configuration for your custom trigger, you could do so by setting the key to the class and the value to an array:

config/airdrop.php{.filename}
config/airdrop.php {.filename}
```php
'triggers' => [
ConfigTrigger::class => [
Expand Down
10 changes: 5 additions & 5 deletions docs/triggers/file.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The File Trigger keeps track of specific files and instructs Airdrop to rebuild assets when any of them change.

config/airdrop.php{.filename}
config/airdrop.php {.filename}
```php
/*
* Trigger a rebuild when files change.
Expand Down Expand Up @@ -48,7 +48,7 @@ FileTrigger::class => [

The File Trigger allows both an `include` and `exclude` key, so if you want to include a whole directory and exclude a particular file, you can do that:

config/airdrop.php{.filename}
config/airdrop.php {.filename}
```php
FileTrigger::class => [
'include' => [
Expand All @@ -65,7 +65,7 @@ FileTrigger::class => [

If you're using NPM to manage your frontend packages, you'll want to include `package-lock.json` so that whenever you add, remove, or upgrade packages then Airdrop will rebuild your assets.

config/airdrop.php{.filename}
config/airdrop.php {.filename}
```php
FileTrigger::class => [
'include' => [
Expand All @@ -77,7 +77,7 @@ FileTrigger::class => [

In the same way, if you're using Yarn, add `yarn.lock`.

config/airdrop.php{.filename}
config/airdrop.php {.filename}
```php
FileTrigger::class => [
'include' => [
Expand All @@ -91,7 +91,7 @@ FileTrigger::class => [

If you're using Tailwind CSS, make sure you include that as well, as any changes to the Tailwind config will affect the resulting assets.

config/airdrop.php{.filename}
config/airdrop.php {.filename}
```php
FileTrigger::class => [
'include' => [
Expand Down

0 comments on commit dd4aef6

Please sign in to comment.