Skip to content
/ hyde Public template

HydePHP - Static Site Generator with the power of Laravel and the simplicity of Markdown.

License

Notifications You must be signed in to change notification settings

hydephp/hyde

Repository files navigation

HydePHP - Static App Builder powered by Laravel

Latest Version on Packagist Total Downloads on Packagist License MIT Test Coverage GitHub Actions CodeQL Analysis StyleCI Status

Make static websites, blogs, and documentation pages with the tools you already know and love.


⚠ Beta Software Warning ⚠

Heads up! HydePHP is still very new. As such there may be bugs (please report them) and breaking changes.

Please wait until v1.0 for production use and remember to backup your source files before updating (use Git!).


About

HydePHP is a content-first Laravel-powered Static Site Builder that allows you to create static HTML pages, blog posts, and documentation sites using Markdown, optionally with YAML Front Matter.

Need more control? You can also use Laravel Blade to get the full power of dynamic templating and absolute control over HTML.

Hyde is modular, configurable, and hackable - allowing you to customize everything - but only if you want to. Hyde follows convention over configuration, allowing you to get an awesome blog or a smooth documentation site up and running in mere minutes. All the TailwindCSS and Blade templates you need for your site are already configured.

See the documentation and learn more at https://hydephp.github.io/docs/

Live Demo

The Hyde site (https://hydephp.github.io/) is fully built with Hyde. That includes the homepage, the blog, and the documentation.

Installation Quick Start

The recommended method of installation is using Composer.

composer create-project hyde/hyde --stability=dev

Full installation guide is at https://hydephp.github.io/docs/master/installation.html

Getting Started - High-level overview

It's a breeze to get started. After creating a new Hyde project, place Markdown or Blade files in the content directories, run the build command, and you're ready to upload your site to your host, or GitHub Pages.

Writing content

You can create content using Markdown by placing the files in and of the following directories: _pages, _posts, and _docs.

If you want to use Blade templates, you can place the views in the '_pages' directory.

You can scaffold files using the hyde make command.

php hyde make:post # Automatically creates the front matter
php hyde make:page "Page Title" [--type="markdown/blade"]

Build the static site

Compile the static site using the hyde build command.

php hyde build # Compile the static site
php hyde rebuild _posts/example.md # Or, compile a single file

See the console command docs for more information on the HydeCLI.

Hacking Hyde

Hyde is designed to be easy to use and easy to customize and hack. See Hacking Hyde for more.

Extensions

Hyde comes with built-in support for Torchlight Syntax Highlighting. All you need to do is to set your API token in your .env file and Hyde will automatically enable the CommonMark extension.

Resources

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security-related issues, please email caen@desilva.se instead of using the issue tracker. All vulnerabilities will be promptly addressed.

Credits

License

The MIT License (MIT). Please see License File for more information.

Attributions

Please see the respective authors' repositories for their license files