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/advanced-features/navigation-api.md b/docs/advanced-features/navigation-api.md index 7facfe0b7bd..bc5036e26b0 100644 --- a/docs/advanced-features/navigation-api.md +++ b/docs/advanced-features/navigation-api.md @@ -1,6 +1,7 @@ --- navigation: label: "Navigation API" +abstract: "The Navigation API introduced in HydePHP v2 powers the main menu and documentation sidebar, and this page shows how to use it to build your own custom navigation menus." --- # Navigation API 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 288323a5b8e..c01a757ad71 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 8c5dbffa187..0c66d0e1be8 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 9c6fa238b85..6f90671bdb9 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 c4732157bbf..e09378988f9 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 7025c3ba559..7ca52af60b3 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 54d14fb3180..34cd7203608 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 97444410c16..687d4dd3e36 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 preconfigured Tailwind and Vite 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 1095fa5b0bc..8696e0cf102 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 865daa7133c..0ba17b54a3a 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 d74b2842093..03c54b55cf0 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 6170b411bfb..1a7259e0b12 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 DataCollection gives 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 d52350726af..cf4318f33aa 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 b792c178774..09e64079e33 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 c378b081b85..4ec0c23e237 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 a999358651d..6cb103a3262 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 603f3368a21..f730bb3e41d 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 f31944cac94..fd0546fc568 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 544951b0b51..1465f6cb84b 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 ac6bd345847..5a22f00378e 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 console commands you'll reach for daily to scaffold files, compile your site, and manage assets." --- # Console Commands diff --git a/docs/getting-started/core-concepts.md b/docs/getting-started/core-concepts.md index 1667466a6f8..f46e2302037 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 a599c447423..92b3a2e2704 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 85d25d046e0..160d09a540a 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/getting-started/release-notes.md b/docs/getting-started/release-notes.md index ec572ee9b92..6f97ea267d0 100644 --- a/docs/getting-started/release-notes.md +++ b/docs/getting-started/release-notes.md @@ -2,6 +2,7 @@ navigation: label: v2 Release Notes priority: 15 +abstract: "HydePHP v2.0 overhauls the asset system and navigation API, replaces Laravel Mix with Vite, and adds numerous performance improvements. This page gives an overview of what changed." --- # HydePHP v2.0 Release Notes diff --git a/docs/getting-started/upgrade-guide.md b/docs/getting-started/upgrade-guide.md index 70896bc5978..7c3c1aacaf2 100644 --- a/docs/getting-started/upgrade-guide.md +++ b/docs/getting-started/upgrade-guide.md @@ -2,6 +2,7 @@ navigation: label: v2 Upgrade Guide priority: 16 +abstract: "A step-by-step guide to upgrading an existing HydePHP site to v2.0, covering the asset system, navigation API, and other breaking changes." --- # HydePHP v2.0 Upgrade Guide diff --git a/docs/index.md b/docs/index.md index dbe1c31b5fe..4171311ced0 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." +--- + # Welcome to HydePHP