Hyde favours "Convention over Configuration" and comes preconfigured with sensible defaults. However, Hyde also strives to be modular and endlessly customizable if you need it. This page guides you through the many options available!
When referencing configuration options, we often use "dot notation" to specify the configuration file. For example,
config('site.name') means that we are looking for the
name option in the
If you want to reference these configuration options in your Blade views, or other integrations, please take a look at the Laravel Documentation.
Front Matter or Configuration Files?#
In some cases, the same options can be set in the front matter of a page or in a configuration file. Both ways are always documented, and it's up to you to choose which one you prefer. Note that in most cases, if a setting is set in both the front matter and the configuration file, the front matter setting will take precedence.
Configuration Files Overview#
There are a few configuration files available in the
config directory. All options are documented, so feel free to look through the files and get familiar with the options available to you.
Below are two tables over the different configuration files. Click on a file name to see the default file on GitHub.
HydePHP Configuration Files#
These are the main configuration files for HydePHP and lets you customize the look and feel of your site, as well as the behaviour of HydePHP.
|site.php||Configuration file for the site presentation settings, like site name and base URL.|
|hyde.php||HydePHP Framework settings, like what features to enable, and navigation menus.|
|docs.php||Options for the HydePHP documentation site generator module.|
|markdown.php||Configure Markdown related services, as well as change the CommonMark extensions.|
Laravel & Package Configuration Files#
Since HydePHP is based on Laravel we also have a few configuration files related to them. You probably don't need to edit any of these unless you want to make changes to the application core.
|app.php||Configures the underlying Laravel application.|
|commands.php||Configures the Laravel Zero commands for the HydeCLI.|
|cache.php||Configures the cache driver and cache path locations.|
|view.php||Configures the paths for the Blade View compiler.|
|torchlight.php||Configures settings for the Torchlight syntax highlighting integration.|
While all options are already documented within the files, here are some further explanations of some of the options.
RSS feed generation#
When enabled, an RSS feed with your Markdown blog posts will be generated when you compile your static site. Note that this requires that a site_url is set!
1'generate_rss_feed' => true, // Default is true
You can customize the output filename using the following:
1'rss_filename' => 'feed.rss', // Default is feed.xml
You can set the RSS channel description using the following:
1'rss_description' => 'A collection of articles and tutorials from my blog', // Example
If an rss_description is not set one is created by appending "RSS Feed" to your site name.
Hyde has support for adding authors in front matter, for example to automatically add a link to your website or social media profiles. However, it's tedious to have to add those to each and every post you make, and keeping them updated is even harder.
You can predefine authors in the Hyde config. When writing posts, just specify the username in the front matter, and the rest of the data will be pulled from a matching entry.
'authors' => [Author::create(username: 'mr_hyde', // Required usernamename: 'Mr. Hyde', // Optional display namewebsite: 'https://hydephp.com' // Optional website URL),],
This is equivalent to the following front matter in a blog post:
1author:2 username: mr_hyde3 name: Mr. Hyde4 website: https://hydephp.com
But you only have to specify the username:
Most websites have a footer with copyright details and contact information. You probably want to change the Markdown to include your information, though you are of course welcome to keep the default attribution link!
The footer component is made up of a few levels of components, depending on how much you want to customize.
Customizing the Markdown text#
There are two ways to customize the footer text. First, you can set it in the configuration file:
Filepath: config/hyde.php1'footer' => 'Site proudly built with [HydePHP](https://github.com/hydephp/hyde) 🎩',
If you don't want to write Markdown in the configuration file, you can create a Markdown file in your includes directory. When this file is found, it will be used instead of the configuration setting.
Filepath: resources/_includes/footer.md1Site proudly built with [HydePHP](https://github.com/hydephp/hyde) 🎩
In both cases the parsed Markdown will be rendered in the footer Blade component.
Customizing the Blade component#
The actual footer component is rendered using the
layouts/footer.blade.php Blade template.
In this template we automatically render the configured footer Markdown text. If you want to change this behaviour, for example, HydePHP.com uses a more sophisticated footer, simply publish the footer component.
Disabling the footer entirely#
If you don't want to have a footer on your site, you can set the
'footer' configuration option to
Filepath: config/hyde.php1'footer' => 'false',
Navigation Menu & Sidebar#
One of my (the author's) favourite features with Hyde is its automatic navigation menu and documentation sidebar generator.
How it works:#
The sidebar works by creating a list of all the documentation pages.
The navigation menu is a bit more sophisticated, it adds all the top-level Blade and Markdown pages. It also adds an automatic link to the docs if there is an
index.md in the
Reordering Sidebar Items#
Sadly, Hyde is not intelligent enough to determine what order items should be in (blame Dr Jekyll for this), so you will probably want to set a custom order.
Reordering items in the documentation sidebar is as easy as can be. In the hyde config, there is an array just for this. When the sidebar is generated it looks through this config array. If a slug is found here it will get priority according to its position in the list. If a page does not exist in the list they get priority 999, which puts them last.
Let's see an example:
// This is the default values in the config. It puts the readme.md first in order.'documentationPageOrder' => ['readme', // This is the first entry, so it gets the priority 0'installation', // This gets priority 1'getting-started', // And this gets priority 2// Any other pages not listed will get priority 999]
Reordering Navigation Menu Items#
Hyde makes an effort to organize the menu items in a sensible way. Putting your most important pages first. This of course may not always be how you want, so it's easy to reorder the menu items. Simply override the
navigation.order array in the Hyde config. The priorities set will determine the order of the menu items. Lower values are higher in the menu. Any pages not listed will get priority 999.
Filepath: config/hyde.php1'navigation' => [2 'order' => [3 'index' => 0, // _pages/index.md (or .blade.php)4 'posts' => 10, // _pages/posts.md (or .blade.php)5 'docs/index' => 100, // _docs/index.md6 ]7]
You can also set the priority of a page directly in the front matter. This will override any dynamically infered or config defined priority. While this is useful for one-offs, it can make it harder to reorder items later on. It's up to you which method you prefer to use.
1---2navigation:3 priority: 104---
Note that since Blade pages do not support front matter, this will only work for Markdown pages.
Adding Custom Navigation Menu Links#
You can easily add custom navigation menu links similar how we add Authors. Simply add a
NavItem model to the
When linking to an external site, you should use the
NavItem::toLink() method facade. The first two arguments are the destination and label, both required. Third argument is the priority, which is optional.
Filepath: config/hyde.php1'navigation' => [2 'custom' => [3 NavItem::toLink('https://github.com/hydephp/hyde', 'GitHub', 200),4 ]5]
Simplified, this will then be rendered as follows:
Excluding Items (Blacklist)#
Sometimes, especially if you have a lot of pages, you may want to prevent links from showing up in the main navigation menu. To remove items from being automatically added, simply add the slug to the blacklist. As you can see, the
404 page has already been filled in for you.
Note that we don't specify the page type, since only top level pages are added to the navigation menu (with the exception of the automatic documentation page link, which can be hidden in the config by using
1'navigation' => [2 'exclude' => [3 '404'4 ]5]
You can also specify that a page should be excluded by setting the page front matter. Note that since Blade pages do not support front matter, this will only work for Markdown pages.
1---2navigation:3 hidden: true4---
Changing the menu item labels#
Hyde makes a few attempts to find a suitable label for the navigation menu items to automatically create helpful titles. You can override the title using the
navigation.title front matter property.
From the Hyde config you can also override the title of navigation links using the by mapping the slug (relative to the site root) to a title. Note that the front matter property will take precedence over the config property.
Filepath: config/hyde.php1'navigation' => [2 'labels' => [3 'index' => 'Start',4 'docs/index' => 'Documentation',5 ]6]
Hyde uses the Laravel templating system called Blade. Most parts have been extracted into components to be customized easily.
Before editing Blade views you should familiarize yourself with how they work in the official documentation https://laravel.com/docs/9.x/blade.
To edit the default component you need to publish them first using the
hyde publish:views command.
The files will then be available in the
Hyde is designed to not only serve as a framework but a whole starter kit and comes with a Tailwind starter template for you to get up and running quickly. If you want to customize these, you are free to do so. Please see the Managing Assets page to learn more.
Hyde uses League CommonMark for converting Markdown into HTML.
Hyde ships with the GitHub Flavored Markdown extension, and the Torchlight extension is enabled automatically when needed.
You can add extra CommonMark extensions, or change the default ones, in the
1'extensions' => [2 \League\CommonMark\Extension\GithubFlavoredMarkdownExtension::class,3 \League\CommonMark\Extension\Attributes\AttributesExtension::class,4 \League\CommonMark\Extension\DisallowedRawHtml\DisallowedRawHtmlExtension::class,5],
In the same file you can also change the config to be passed to the CommonMark environment.
1'config' => [2 'disallowed_raw_html' => [3 'disallowed_tags' => ,4 ],5],