Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/advanced-features/advanced-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions docs/advanced-features/build-tasks.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/advanced-features/hyde-pages.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
4 changes: 4 additions & 0 deletions docs/advanced-features/in-memory-pages.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/advanced-features/navigation-api.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/architecture-concepts/architecture-concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions docs/architecture-concepts/autodiscovery.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
4 changes: 4 additions & 0 deletions docs/architecture-concepts/automatic-routing.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
4 changes: 4 additions & 0 deletions docs/architecture-concepts/dynamic-data-discovery.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
1 change: 1 addition & 0 deletions docs/architecture-concepts/extensions-api.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/architecture-concepts/page-models.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
4 changes: 4 additions & 0 deletions docs/architecture-concepts/the-hydekernel.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/creating-content/blog-posts.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/creating-content/compile-and-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/creating-content/documentation-pages.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/creating-content/managing-assets.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/creating-content/static-pages.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/digging-deeper/advanced-customization.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/digging-deeper/advanced-markdown.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/digging-deeper/collections.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/digging-deeper/customization.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/digging-deeper/helpers.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/digging-deeper/navigation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/digging-deeper/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/digging-deeper/updating-hyde.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/extensions/extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/extensions/realtime-compiler.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/extensions/third-party-integrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions docs/extensions/ui-kit.md
Original file line number Diff line number Diff line change
@@ -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,
Expand Down
1 change: 1 addition & 0 deletions docs/getting-started/console-commands.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/getting-started/core-concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/getting-started/front-matter.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/getting-started/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/getting-started/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/getting-started/upgrade-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -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

<style>.images-inline img { display: inline; margin: 4px 2px;}</style>
Expand Down
Loading