This is the main HydePHP configuration file. This is the place to customize site settings and more.
Note that the actual file is extensively commented, describing each option. This preview has been shorted for brevity.
<?php
/*
|--------------------------------------------------------------------------
| __ __ __ ___ __ _____
| / // /_ _____/ /__ / _ \/ // / _ \
| / _ / // / _ / -_) ___/ _ / ___/
| /_//_/\_, /\_,_/\__/_/ /_//_/_/
| /___/
|--------------------------------------------------------------------------
|
| Welcome to HydePHP! In this file, you can customize your new Static Site!
|
| HydePHP favours convention over configuration and as such requires virtually
| no configuration out of the box to get started. Though, you may want to
| change the options to personalize your site and make it your own!
|
*/
return [
/*
|--------------------------------------------------------------------------
| Site Name
|--------------------------------------------------------------------------
*/
'name' => $siteName = env('SITE_NAME', 'HydePHP'),
/*
|--------------------------------------------------------------------------
| Site URL Configuration
|--------------------------------------------------------------------------
*/
'site_url' => env('SITE_URL', 'https://example.com'),
'pretty_urls' => false,
'generate_sitemap' => true,
/*
|--------------------------------------------------------------------------
| Site Language
|--------------------------------------------------------------------------
*/
'language' => 'en',
/*
|--------------------------------------------------------------------------
| Global Site Meta Tags
|--------------------------------------------------------------------------
*/
'meta' => [
Meta::name('author', 'Mr. Hyde'),
Meta::name('twitter:creator', '@HydeFramework'),
Meta::name('description', 'My Hyde Blog'),
Meta::name('keywords', 'Static Sites, Blogs, Documentation'),
Meta::name('generator', 'HydePHP '.Hyde\Framework\Hyde::version()),
Meta::property('site_name', $siteName),
],
/*
|--------------------------------------------------------------------------
| Features
|--------------------------------------------------------------------------
*/
'features' => [
Features::blogPosts(),
Features::bladePages(),
Features::markdownPages(),
Features::documentationPages(),
Features::documentationSearch(),
Features::torchlight(),
Features::darkmode(),
],
/*
|--------------------------------------------------------------------------
| Blog Post Authors
|--------------------------------------------------------------------------
*/
'authors' => [
Author::create(
username: 'mr_hyde',
name: 'Mr. Hyde',
website: 'https://hydephp.com'
),
],
/*
|--------------------------------------------------------------------------
| Footer Text
|--------------------------------------------------------------------------
*/
'footer' => [
'enabled' => true,
'markdown' => 'Site proudly built with [HydePHP](https://github.com/hydephp/hyde) 🎩',
],
/*
|--------------------------------------------------------------------------
| Navigation Menu Configuration
|--------------------------------------------------------------------------
*/
'navigation' => [
'order' => [
'index' => 0,
'posts' => 10,
'docs' => 100,
],
'exclude' => [
'404',
],
'custom' => [
NavItem::toLink('https://github.com/hydephp/hyde', 'GitHub', 200),
],
],
/*
|--------------------------------------------------------------------------
| Site Output Directory (Experimental 🧪)
|--------------------------------------------------------------------------
*/
'output_directory' => '_site',
];