Add Command docs

Author: robdekort

docs/README.md

@@ -1,6 +1,6 @@
-# Peak Statamic Starter Kit Docs
+# Peak docs
 
-These are the [docs](https://peak.studio1902.nl) repo for Peak. The docs run on https://vuepress.vuejs.org. 
+These are the [docs](https://peak.studio1902.nl) repo for Peak. The docs run on https://vuepress.vuejs.org.
 
 ## Compile
 

docs/docs/.vuepress/.cache/default-development/2.pack

@@ -15,7 +15,7 @@
 </blockquote>
 <h2 id="background-images" tabindex="-1"><a class="header-anchor" href="#background-images" aria-hidden="true">#</a> Background images</h2>
 <p>Peak comes with a background image snippet you can use to apply responsive images (WebP included) to an elements background. Just use</p>
-<div class="language-html ext-html line-numbers-mode"><pre v-pre class="language-html"><code>{{ partial:snippets/background_image image="YOUR_IMAGE" selector="SELECTOR_OF_ELEMENT_THAT_NEEDS_BG_IMAGE" }}
+<div class="language-html ext-html line-numbers-mode"><pre v-pre class="language-html"><code>{{ partial:snippets/background_image image="YOUR_IMAGE" class="CLASS_OF_ELEMENT_THAT_NEEDS_BG_IMAGE" }}
 </code></pre><div class="line-numbers"><span class="line-number">1</span><br></div></div><p>The predefined sizes used in <code>resources/views/snippets/_background_image.antlers.html</code> are defined in <code>config/statamic/assets.php</code>.</p>
 <blockquote>
 <p>Note: You can use either a hardcoded image or an image from an asset field.</p>

docs/docs/.vuepress/.cache/default-development/3.pack

@@ -3,8 +3,6 @@
 <ul>
 <li><a href="https://laravel-news.com/statamic-peak" target="_blank" rel="noopener noreferrer">Peak on Laravel News<OutboundLink/></a></li>
 </ul>
-<h2 id="video-s-on-peak" tabindex="-1"><a class="header-anchor" href="#video-s-on-peak" aria-hidden="true">#</a> Video's on Peak</h2>
-<div class='embed-container'><iframe src='https://www.youtube.com/embed/79Ist1HrHoA' frameborder='0' allowfullscreen></iframe></div>
 <h2 id="made-with-peak" tabindex="-1"><a class="header-anchor" href="#made-with-peak" aria-hidden="true">#</a> Made with Peak</h2>
 <p>This is a collection of sites made with Statamic using Peak:</p>
 <ul>

docs/docs/.vuepress/.cache/default-development/6.pack

@@ -25,6 +25,21 @@
 <td>A command to generate all files needed to add a block to the <RouterLink to="/features/page-builder.html#adding-blocks">page builder</RouterLink>.</td>
 </tr>
 <tr>
+<td><code>app/Console/Commands/AddBlock.php</code></td>
+<td></td>
+<td>A command to generate all files needed to add a block to the <RouterLink to="/features/page-builder.html#adding-blocks">page builder</RouterLink>.</td>
+</tr>
+<tr>
+<td><code>app/Console/Commands/stubs/block.html.stub</code></td>
+<td></td>
+<td>A stub file for the <code>peak:add-block</code> command.</td>
+</tr>
+<tr>
+<td><code>app/Console/Commands/stubs/fieldset.yaml.stub</code></td>
+<td></td>
+<td>A stub file for the <code>peak:add-block</code> command.</td>
+</tr>
+<tr>
 <td><code>app/Actions/GenerateSocialImages.php</code></td>
 <td></td>
 <td>An action to <RouterLink to="/features/social-images-generation.html">generate social images</RouterLink> for entries.</td>

docs/docs/.vuepress/.temp/pages/features/assets.html.vue

@@ -1,4 +1,29 @@
 <template><h1 id="contributing" tabindex="-1"><a class="header-anchor" href="#contributing" aria-hidden="true">#</a> Contributing</h1>
 <p>Contributions and discussions are always welcome, no matter how large or small. Treat each other with respect. Read the <a href="https://github.com/studio1902/statamic-peak/blob/main/.github/CODE_OF_CONDUCT.md" target="_blank" rel="noopener noreferrer">Code of Conduct<OutboundLink/></a>.</p>
-<p>These docs are setup using VuePress by <a href="https://github.com/robertguss/" target="_blank" rel="noopener noreferrer">Robert Guss<OutboundLink/></a>. Thank you so much!</p>
+<p>Statamic Peak is a mono repo. If you want to contribute make sure you target files the <code>/dev/</code> folder and run your local install from this folder. When you use valet you can navigate to the folder and type: <code>valet link statamic-peak</code>.</p>
+<h2 id="repo-structure" tabindex="-1"><a class="header-anchor" href="#repo-structure" aria-hidden="true">#</a> Repo structure</h2>
+<table>
+<thead>
+<tr>
+<th>Location</th>
+<th>Purpose</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><code>/</code></td>
+<td>The root level contains the actual kit that gets installed by Statamic.</td>
+</tr>
+<tr>
+<td><code>/docs/</code></td>
+<td>The documentation auto deployed to <a href="https://peak.studio1902.nl" target="_blank" rel="noopener noreferrer">peak.studio1902.nl<OutboundLink/></a> running on Netlify.</td>
+</tr>
+<tr>
+<td><code>/dev/</code></td>
+<td>The actual development environment. A running Statamic Peak instance.</td>
+</tr>
+</tbody>
+</table>
+<h2 id="thanks" tabindex="-1"><a class="header-anchor" href="#thanks" aria-hidden="true">#</a> Thanks</h2>
+<p>These docs are initially setup using VuePress 1 by <a href="https://github.com/robertguss/" target="_blank" rel="noopener noreferrer">Robert Guss<OutboundLink/></a>. Thank you so much! Today we run VuePress 2.</p>
 </template>

docs/docs/.vuepress/.temp/pages/other/awesome.html.vue

@@ -58,6 +58,7 @@ module.exports = {
             '/features/bard.md',
             '/features/browser-appearance.md',
             '/features/buttons.md',
+            '/features/commands.md',
             '/features/dark-mode.md',
             '/features/forms.md',
             '/features/globals.md',
@@ -83,6 +84,7 @@ module.exports = {
             '/other/lighthouse.md',
             '/other/localization.md',
             '/other/reduced-motion.md',
+            '/other/screencasts.md',
             '/other/tags.md',
             '/other/toolbar.md',
             '/other/upcoming-features.md',

docs/docs/.vuepress/.temp/pages/other/configuration-changes.html.vue

@@ -0,0 +1,27 @@
+# Commands
+
+Peak comes with a growing collection of CLI commands to make tedious recurring tasks easier.
+
+## Add Page Builder Block
+This command adds a block to the Peak Page Builder and generates the files needed.
+
+Run `php please peak:add-block` to:
+
+* Add a set to the Page Builder replicator in `resources/fieldsets/page_builder.yaml`.
+* Create a fieldset for your block in `resources/fieldsets/{file_name}.yaml`.
+* Create a partial with default markup and IDE hinting in `resources/views/page_builder/_{file_name}.antlers.html`.
+
+<div class='embed-container'><iframe src='https://www.youtube.com/embed/wW1D53nG61c' frameborder='0' allowfullscreen></iframe></div>
+
+## 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.
+
+Run `php please peak:add-collection` to:
+
+* Create a collection in `content/collections/{handle}.yaml` with the variables you defined in the CLI.
+* Create a blueprint for collection in `resources/blueprints/collections/pages/{handle}.yaml` containing the page builder fieldset and the SEO tab when your collection has a public route defined.
+* Optionally create an index partial in `resources/views/{handle}/index.antlers.html` with default Peak markup.
+* Optionally set the index template to the entry you chose to mount the collection on.
+* Optionally create a show partial in `resources/views/{handle}/show.antlers.html` with default Peak markup.
+
+<div class='embed-container'><iframe src='https://www.youtube.com/embed/JWVDvTFDvHA' frameborder='0' allowfullscreen></iframe></div>