Installing HydePHP using Composer#
The recommended method of installing Hyde is using Composer.
composer create-project hyde/hyde --stability=dev
These requirements are for your local development environment.
Hyde is based on Laravel 9 which requires a minimum PHP version of 8.0. You should also have Composer installed.
To use some features like compiling your own assets you also need NodeJS and NPM.
Using the Hyde CLI#
The main way to interact with Hyde is through HydeCLI.
If you are familiar with Laravel Artisan you will feel right at home.
Learn more about the HydeCLI in the console commands documentation.
Starting a development server#
To make previewing your site a breeze you can use the real-time compiler which builds your pages on the fly. Start it using the HydeCLI:
1php hyde serve
Creating content with Hyde is easy. Simply place Markdown files in one of the source directories, which are as follows:
├── _docs // For documentation pages├── _posts // For blog posts└── _pages // For static Markdown and Blade pages
There are a few more directories that you should know about. Please see the directory structure section.
You can scaffold blog post files using the
php hyde make:post command with automatically creates the front matter based on your input selections.
You can also scaffold pages with the
php hyde make:page command.
1php hyde make:page "Page Title" # Markdown is the default page type2php hyde make:page --type=blade # Creates a file extending the default layout3php hyde make:page --type=docs # Quickly creates a documentation page
When building the site, Hyde will your source directories for files and compile them into static HTML using the appropriate layout depending on what kind of page it is. You don't have to worry about routing as Hyde takes care of that, including creating navigation menus!
Compiling to static HTML#
Now that you have some amazing content, you'll want to compile your site into static HTML.
This is as easy as executing the
1php hyde build
Your site is then stored in the
Hyde comes bundled with a precompiled and minified
app.css containing all the Tailwind you need for the default views meaning that you don't even need to use NPM. However, Hyde is already configured to use Laravel Mix to compile your assets if you feel like there's a need to. See more on the Managing Assets page.
Deploying your site#
You are now ready to show your site to the world!
Simply copy the
_site directory to your web server's document root, and you're ready to go.
You can even use GitHub pages to host your site for free. That's what the Hyde website does, using a CI that automatically builds and deploys this site.
Here's some ideas of what to read next: