Skip to content

Commit

Permalink
Add peak:add-set documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
robdekort committed Nov 4, 2021
1 parent 7f7577d commit 1d4798c
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
9 changes: 9 additions & 0 deletions docs/docs/features/commands.md
Expand Up @@ -13,6 +13,15 @@ Run `php please peak:add-block` to:

<div class='embed-container'><iframe src='https://www.youtube.com/embed/wW1D53nG61c' frameborder='0' allowfullscreen></iframe></div>

## Add Page Builder Article Set
This command adds a set to the Peak Page Builder Article (Bard) blocko and generates the files needed.

Run `php please peak:add-set` to:

* Add a set to the Article Bard in `resources/fieldsets/article.yaml`.
* Create a fieldset for your set in `resources/fieldsets/{file_name}.yaml`.
* Create a component partial with default markup and IDE hinting in `resources/views/components/_{file_name}.antlers.html`.

## Add Collection
This command creates a new collection and scaffolds out all needed files with some sane default markup containing the various Peak utilities we use.

Expand Down
5 changes: 4 additions & 1 deletion docs/docs/other/configuration-changes.md
Expand Up @@ -7,10 +7,13 @@ Peak changes the default Statamic config. The following is different:
| `.env.example` | | Add more default Statamic and Redis settings by default.
| `app/Console/Kernel.php` | | Add a schedule you can invoke via a cron to warm all caches.
| `app/Console/Commands/AddBlock.php` | | A command to generate all files needed to [add a block to the page builder](/features/commands.html#add-page-builder-block).
| `app/Console/Commands/AddSet.php` | | A command to generate all files needed to [add a set to the page builder article](/features/commands.html#add-page-builder-article-set).
| `app/Console/Commands/AddCollection.php` | | A command to generate all files needed to [add a collection](/features/commands.html#add-collection).
| `app/Console/Commands/ClearSite.php` | | A command to [clear all default Peak content](/features/commands.html#clear-site).
| `app/Console/Commands/stubs/block.html.stub` | | A stub file for the `peak:add-block` command.
| `app/Console/Commands/stubs/fieldset.yaml.stub` | | A stub file for the `peak:add-block` command.
| `app/Console/Commands/stubs/set.html.stub` | | A stub file for the `peak:add-set` command.
| `app/Console/Commands/stubs/fieldset_block.yaml.stub` | | A stub file for the `peak:add-block` command.
| `app/Console/Commands/stubs/fieldset_set.yaml.stub` | | A stub file for the `peak:add-set` command.
| `app/Actions/GenerateSocialImages.php` | | An action to [generate social images](/features/social-images-generation.html) for entries.
| `app/Http/Controllers/DynamicToken.php` | | New Controller for [forms](/features/forms.html) |
| `app/Http/Middleware/VerifyCsrfToken.php` | `protected $except = []` | `protected $except = ['/!/DynamicToken']` |
Expand Down

0 comments on commit 1d4798c

Please sign in to comment.