diff --git a/docs/advanced-features/advanced-features.md b/docs/advanced-features/advanced-features.md index e88283832a8..85b2f5b4ce1 100644 --- a/docs/advanced-features/advanced-features.md +++ b/docs/advanced-features/advanced-features.md @@ -2,6 +2,7 @@ navigation: label: Introduction priority: 40 +abstract: "An overview of the optional, more advanced features HydePHP offers once you've outgrown the basics, from custom build tasks to in-memory pages." --- # Advanced Features in HydePHP diff --git a/docs/advanced-features/build-tasks.md b/docs/advanced-features/build-tasks.md index 8852b58aab1..b85e9c0c4e7 100644 --- a/docs/advanced-features/build-tasks.md +++ b/docs/advanced-features/build-tasks.md @@ -1,3 +1,7 @@ +--- +abstract: "The Build Task API lets you hook into HydePHP's build process to run custom logic, or override built-in tasks like sitemap and RSS generation, whenever the site compiles." +--- + # Custom Build Tasks ## Introduction diff --git a/docs/advanced-features/hyde-pages.md b/docs/advanced-features/hyde-pages.md index 7cf2249d73b..0413792eed0 100644 --- a/docs/advanced-features/hyde-pages.md +++ b/docs/advanced-features/hyde-pages.md @@ -1,6 +1,7 @@ --- navigation: label: "HydePage API" +abstract: "Full API reference for HydePHP's built-in HydePage classes, useful if you're extending the framework or building your own custom page classes and Blade templates." --- # HydePage API Reference diff --git a/docs/advanced-features/in-memory-pages.md b/docs/advanced-features/in-memory-pages.md index e02b4b1d033..4d898519e48 100644 --- a/docs/advanced-features/in-memory-pages.md +++ b/docs/advanced-features/in-memory-pages.md @@ -1,3 +1,7 @@ +--- +abstract: "InMemoryPages are HydePHP pages generated at runtime rather than backed by a file on disk, handy for package developers and one-off custom pages." +--- + # InMemoryPages ## Introduction diff --git a/docs/architecture-concepts/architecture-concepts.md b/docs/architecture-concepts/architecture-concepts.md index 5a991705b43..185ababffe4 100644 --- a/docs/architecture-concepts/architecture-concepts.md +++ b/docs/architecture-concepts/architecture-concepts.md @@ -2,6 +2,7 @@ navigation: label: Introduction priority: 50 +abstract: "A power-user's introduction to the internals of HydePHP, covering how the framework's architecture works under the hood for those extending or contributing to it." --- # Advanced Architecture Concepts diff --git a/docs/architecture-concepts/autodiscovery.md b/docs/architecture-concepts/autodiscovery.md index fde9d6e6ddb..0e058718ef3 100644 --- a/docs/architecture-concepts/autodiscovery.md +++ b/docs/architecture-concepts/autodiscovery.md @@ -1,3 +1,7 @@ +--- +abstract: "Autodiscovery is how HydePHP automatically finds and registers your pages without configuration. This article explains how it works and the lifecycle of the HydeKernel." +--- + # Autodiscovery ## Introduction diff --git a/docs/architecture-concepts/automatic-routing.md b/docs/architecture-concepts/automatic-routing.md index b4b2ac221d8..a5ba0cec774 100644 --- a/docs/architecture-concepts/automatic-routing.md +++ b/docs/architecture-concepts/automatic-routing.md @@ -1,3 +1,7 @@ +--- +abstract: "HydePHP automatically builds a route index linking source files to compiled output during autodiscovery. This page covers how routing works and the helpers you can use in Blade templates." +--- + ## Automatic Routing >info This covers an intermediate topic which is not required for basic usage, but is useful if you want to use the framework to design custom Blade templates. diff --git a/docs/architecture-concepts/dynamic-data-discovery.md b/docs/architecture-concepts/dynamic-data-discovery.md index bb8d3e51015..f4987b8a0f7 100644 --- a/docs/architecture-concepts/dynamic-data-discovery.md +++ b/docs/architecture-concepts/dynamic-data-discovery.md @@ -1,3 +1,7 @@ +--- +abstract: "HydePHP tries to fill in the gaps in your front matter automatically. This article explains how dynamic data discovery works so you can write less and let Hyde do more." +--- + # Dynamic Data Discovery [//]: # (Adds a pseudo-subtitle) diff --git a/docs/architecture-concepts/extensions-api.md b/docs/architecture-concepts/extensions-api.md index d71e6a258b5..17691c94de6 100644 --- a/docs/architecture-concepts/extensions-api.md +++ b/docs/architecture-concepts/extensions-api.md @@ -1,5 +1,6 @@ --- navigation.priority: 1000 +abstract: "The Extensions API lets package developers hook directly into the HydePHP Kernel to add custom page types and new features, explained here through a series of practical examples." --- # The Extensions API diff --git a/docs/architecture-concepts/page-models.md b/docs/architecture-concepts/page-models.md index ce9e2376734..9debc77d0fb 100644 --- a/docs/architecture-concepts/page-models.md +++ b/docs/architecture-concepts/page-models.md @@ -1,5 +1,6 @@ --- title: Page models +abstract: "Page models are the PHP classes at the heart of how HydePHP builds your site. This article gives a high-level overview of how they hold and process your content." --- # The Hyde Page Models diff --git a/docs/architecture-concepts/the-hydekernel.md b/docs/architecture-concepts/the-hydekernel.md index e7cd81eecb4..56a347f1353 100644 --- a/docs/architecture-concepts/the-hydekernel.md +++ b/docs/architecture-concepts/the-hydekernel.md @@ -1,3 +1,7 @@ +--- +abstract: "The HydeKernel is the core object encapsulating a HydePHP project, and the engine behind the Hyde facade you use throughout the framework." +--- + # The HydeKernel ## Introduction diff --git a/docs/creating-content/blog-posts.md b/docs/creating-content/blog-posts.md index 8f3dd87a4bf..d4117d86ce3 100644 --- a/docs/creating-content/blog-posts.md +++ b/docs/creating-content/blog-posts.md @@ -2,6 +2,7 @@ navigation: label: "Creating Blog Posts" priority: 11 +abstract: "Everything you need to start writing blog posts in HydePHP, from dropping a Markdown file in _posts to scaffolding one with front matter using the HydeCLI." --- # Creating Blog Posts diff --git a/docs/creating-content/compile-and-deploy.md b/docs/creating-content/compile-and-deploy.md index ff768885714..aad77dfbfe5 100644 --- a/docs/creating-content/compile-and-deploy.md +++ b/docs/creating-content/compile-and-deploy.md @@ -2,6 +2,7 @@ navigation: priority: 25 label: "Compile & Deploy" +abstract: "Once your HydePHP content is ready, this page covers running the build command to compile your site into static HTML and deploying it wherever you like." --- # Compile and Deploy Your Site diff --git a/docs/creating-content/documentation-pages.md b/docs/creating-content/documentation-pages.md index 85b1ee52381..32659324113 100644 --- a/docs/creating-content/documentation-pages.md +++ b/docs/creating-content/documentation-pages.md @@ -2,6 +2,7 @@ navigation: label: Documentation Pages priority: 12 +abstract: "HydePHP's Documentation module turns Markdown files in your _docs directory into a full documentation site with an automatically generated, customizable sidebar." --- # Creating Documentation Pages diff --git a/docs/creating-content/managing-assets.md b/docs/creating-content/managing-assets.md index a6eba76523e..74e387dfb64 100644 --- a/docs/creating-content/managing-assets.md +++ b/docs/creating-content/managing-assets.md @@ -1,6 +1,7 @@ --- navigation: priority: 20 +abstract: "HydePHP ships with a complete preconfigured frontend so you don't have to think about asset compilation, but this page covers how to customize it if you want to." --- # Managing and Compiling Assets diff --git a/docs/creating-content/static-pages.md b/docs/creating-content/static-pages.md index 8eef4a50093..40053fb566d 100644 --- a/docs/creating-content/static-pages.md +++ b/docs/creating-content/static-pages.md @@ -2,6 +2,7 @@ navigation: priority: 11 label: "Markdown & Blade Pages" +abstract: "HydePHP offers two ways to build static pages: content-focused Markdown pages, and Blade pages for when you need full control over the HTML and dynamic PHP." --- # Creating Static Pages diff --git a/docs/digging-deeper/advanced-customization.md b/docs/digging-deeper/advanced-customization.md index 0488dabf7e0..038383f7034 100644 --- a/docs/digging-deeper/advanced-customization.md +++ b/docs/digging-deeper/advanced-customization.md @@ -2,6 +2,7 @@ navigation: label: "Advanced Customization" priority: 30 +abstract: "Example-driven coverage of advanced HydePHP customization options, intended for developers who already know their way around the framework's directory structure." --- # Advanced Customization diff --git a/docs/digging-deeper/advanced-markdown.md b/docs/digging-deeper/advanced-markdown.md index bf58e739fd1..aa011f01430 100644 --- a/docs/digging-deeper/advanced-markdown.md +++ b/docs/digging-deeper/advanced-markdown.md @@ -2,6 +2,7 @@ navigation: label: "Advanced Markdown" priority: 27 +abstract: "HydePHP extends standard Markdown with extra features and helpers, including the ability to use Laravel Blade directly inside your Markdown files." --- # Advanced Markdown diff --git a/docs/digging-deeper/collections.md b/docs/digging-deeper/collections.md index 4cfc75ba1af..f5c411a41dd 100644 --- a/docs/digging-deeper/collections.md +++ b/docs/digging-deeper/collections.md @@ -2,6 +2,7 @@ navigation: priority: 35 label: "File-based Collections" +abstract: "HydePHP's DataCollections give you a Laravel Collections-like developer experience over file-based data such as Markdown, YAML, and JSON, with no database required." --- # File-based Collections diff --git a/docs/digging-deeper/customization.md b/docs/digging-deeper/customization.md index 69f96b6041c..2d9d27c38b1 100644 --- a/docs/digging-deeper/customization.md +++ b/docs/digging-deeper/customization.md @@ -2,6 +2,7 @@ navigation: label: "Customizing your Site" priority: 25 +abstract: "HydePHP favors convention over configuration with sensible defaults out of the box, but this page walks through the many options available for customizing your site." --- # Customizing Your Site diff --git a/docs/digging-deeper/helpers.md b/docs/digging-deeper/helpers.md index 5f36617e39e..d66c98b99c7 100644 --- a/docs/digging-deeper/helpers.md +++ b/docs/digging-deeper/helpers.md @@ -2,6 +2,7 @@ navigation: priority: 35 label: "Helpers and Utilities" +abstract: "A rundown of the most important helper classes and utilities HydePHP provides for developers writing custom code and Blade templates." --- # Helpers and Utilities diff --git a/docs/digging-deeper/navigation.md b/docs/digging-deeper/navigation.md index 30ada596554..de661874a31 100644 --- a/docs/digging-deeper/navigation.md +++ b/docs/digging-deeper/navigation.md @@ -2,6 +2,7 @@ navigation: label: "Navigation Menus" priority: 26 +abstract: "HydePHP automatically generates navigation menus based on your project files. This page covers the two menu types and how to customize them further." --- # Navigation Menus diff --git a/docs/digging-deeper/troubleshooting.md b/docs/digging-deeper/troubleshooting.md index 1c48a13bb6e..770cb4f66ad 100644 --- a/docs/digging-deeper/troubleshooting.md +++ b/docs/digging-deeper/troubleshooting.md @@ -1,6 +1,7 @@ --- navigation: priority: 35 +abstract: "Common issues and gotchas you might run into with HydePHP's automatic, convention-driven features, plus how to use the built-in validate command to catch them." --- # Troubleshooting diff --git a/docs/digging-deeper/updating-hyde.md b/docs/digging-deeper/updating-hyde.md index 1ef99c069c7..9d9634d05ec 100644 --- a/docs/digging-deeper/updating-hyde.md +++ b/docs/digging-deeper/updating-hyde.md @@ -1,6 +1,7 @@ --- navigation: priority: 35 +abstract: "A guide to updating an existing HydePHP project to the latest version, covering backups, version compatibility, and the recommended upgrade steps." --- # Updating Hyde Projects diff --git a/docs/extensions/extensions.md b/docs/extensions/extensions.md index 5bb8d4653f9..536daf2b455 100644 --- a/docs/extensions/extensions.md +++ b/docs/extensions/extensions.md @@ -2,6 +2,7 @@ navigation: label: "Extensions & Integrations" priority: 80 +abstract: "HydePHP is designed to be extensible, with a number of built-in extensions and integrations as well as support for third-party ones." --- # Extensions & Integrations diff --git a/docs/extensions/realtime-compiler.md b/docs/extensions/realtime-compiler.md index 5ae7d796fd7..c3620b6b685 100644 --- a/docs/extensions/realtime-compiler.md +++ b/docs/extensions/realtime-compiler.md @@ -2,6 +2,7 @@ navigation: label: "Realtime Compiler" priority: 81 +abstract: "The HydePHP Realtime Compiler powers the `php hyde serve` command, letting you preview your static site on a local development server without rebuilding it." --- # Realtime Compiler diff --git a/docs/extensions/third-party-integrations.md b/docs/extensions/third-party-integrations.md index 1f240351469..b2fbc364d0d 100644 --- a/docs/extensions/third-party-integrations.md +++ b/docs/extensions/third-party-integrations.md @@ -2,6 +2,7 @@ navigation: label: "Third-Party Integrations" priority: 85 +abstract: "HydePHP has built-in support for third-party services like Torchlight for syntax highlighting. This page covers getting started with each integration." --- # Integrations with Third-Party Services diff --git a/docs/extensions/ui-kit.md b/docs/extensions/ui-kit.md index b632c0719cc..efedd08bbe5 100644 --- a/docs/extensions/ui-kit.md +++ b/docs/extensions/ui-kit.md @@ -1,3 +1,7 @@ +--- +abstract: "The HydePHP UI Kit is a collection of minimalistic, un-opinionated TailwindCSS components for Laravel Blade, built for use with HydePHP sites." +--- + # HydePHP UI Kit - Documentation The HydePHP UI Kit is a collection of minimalistic and un-opinionated TailwindCSS components for Laravel Blade, diff --git a/docs/getting-started/console-commands.md b/docs/getting-started/console-commands.md index c6e4471c4eb..33002e05eb5 100644 --- a/docs/getting-started/console-commands.md +++ b/docs/getting-started/console-commands.md @@ -1,6 +1,7 @@ --- navigation: priority: 5 +abstract: "HydePHP's command line is built on Laravel Zero, so everything here will feel like Artisan. This page covers the commands you'll reach for daily when creating and building your site." --- # Console Commands diff --git a/docs/getting-started/core-concepts.md b/docs/getting-started/core-concepts.md index 99d343fb6bc..eb61ae8fa0a 100644 --- a/docs/getting-started/core-concepts.md +++ b/docs/getting-started/core-concepts.md @@ -2,6 +2,7 @@ navigation: priority: 10 label: Core Concepts +abstract: "A high-level overview of what makes HydePHP special, from autodiscovery to intelligent data generation, so you can quickly grasp the framework's benefits before diving deeper." --- # Core HydePHP Concepts diff --git a/docs/getting-started/front-matter.md b/docs/getting-started/front-matter.md index ea41a9fc581..3dee75ffd46 100644 --- a/docs/getting-started/front-matter.md +++ b/docs/getting-started/front-matter.md @@ -1,6 +1,7 @@ --- navigation: priority: 10 +abstract: "Front matter is a block of YAML metadata at the top of a Markdown file that HydePHP uses to generate rich, dynamic content, from post categories to sidebar labels." --- # Front Matter diff --git a/docs/getting-started/quickstart.md b/docs/getting-started/quickstart.md index 6f962d031cf..9c52accc01d 100644 --- a/docs/getting-started/quickstart.md +++ b/docs/getting-started/quickstart.md @@ -2,6 +2,7 @@ navigation: label: Quickstart Guide priority: 1 +abstract: "Get a new HydePHP project up and running in minutes, from installing via Composer to compiling your first static site." --- # Quickstart Guide diff --git a/docs/index.md b/docs/index.md index 86636842179..89e6c5d279b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,7 @@ +--- +abstract: "HydePHP is a Static Site Generator focused on writing content, not markup, letting you build fast, lightweight static websites, blogs, and documentation with Markdown and Laravel Blade." +--- + # Elegant and Powerful Static Site Generator