hyde/hyde

Static Site Generator to rapidly create Blogs, Documentation, and more, using Markdown and Blade.

Fund package maintenance!
www.buymeacoffee.com/caen

Installs: 102

Dependents: 0

Suggesters: 1

Security: 0

Stars: 22

Watchers: 0

Forks: 0

Open Issues: 2

Type:project


README

Latest Version on Packagist Total Downloads on Packagist License MIT Test Coverage Test Suite

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

About HydePHP

HydePHP is a content-first Laravel-powered console application that allows you to create static HTML pages, blog posts, and documentation sites, using your choice of Markdown and/or Blade.

Build sites in record-time with a full batteries-included TailwindCSS frontend that just works without any fuzz.

Speed & simplicity first, full control when you need it.

Hyde is all about letting you get started quickly by giving you a full-featured frontend starter kit, while also giving you the power and freedom of doing things the way you want to.

Markdown purist? That's all you need. Blade artisan? Go for it. Hyde comes with hand-crafted frontend templates so you can focus on your content. You don't need to customize anything. But you can customize everything.

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

Features

Content Creation

  • Create blog posts using Markdown and Front Matter.
  • Create documentation pages from plain Markdown, no front matter needed!
  • Create simple pages using Markdown, or create advanced ones using Laravel Blade.
  • You can scaffold blog posts and Markdown pages to automatically fill in the front matter.
  • You can also scaffold Blade pages to automatically use the default layout.

Built-in Frontend

  • Hyde comes with a TailwindCSS starter kit so you can start making content right away.
  • The starter kit is fully responsive, has a dark mode theme, and is customizable.
  • The frontend is accessible to screenreaders and rich with semantic HTML and microdata.
  • Hyde automatically chooses the right layout to use depending on the content being rendered.
  • Hyde also fills in and creates content like navigation menus and sidebars automatically.

Easy Asset Managing

  • The Hyde starter comes with HydeFront to serve the base stylesheet and JavaScript through the jsDelivr CDN.
  • Hyde ships with precompiled and minified TailwindCSS styles in the app.css file, you can also load them through the CDN.
  • This means that all the styles you need are already installed. However, if you want to customize the Tailwind config, or if you add new Tailwind classes through Blade files, you can simply run the npm run dev command to recompile the styles using Laravel Mix.

Customization

  • You don't need to configure anything as Hyde is shipped with sensible defaults.
  • You can, however, customize nearly everything. Here are some examples:
  • All frontend components and page layouts are created with Blade so you can publish the vendor views, just like in Laravel.
  • Override many of the dynamic content features like the menus and footer.

Getting Started - High-level overview

See Installation Guide and Getting Started for the full details.

It's a breeze to get started with Hyde. Create a new Hyde project using Composer:

composer create-project hyde/hyde

Next, place your Markdown files in one of the content directories: _posts, _docs, and _pages which also accepts Blade files. You can also use use the hyde:make command to scaffold them.

When you're ready, run the build command to compile your static site which will save your HTML files in the _site directory.

php hyde build

⚠ Beta Software Warning

Heads up! HydePHP is still new and currently in beta. Please report any bugs and issues in the appropriate issue tracker. Versions in the 0.x series might not be stable and may change at any time. No backwards compatibility guarantees are made and there will be breaking changes without notice.

Please wait until v1.0 for production use and remember to back up your source files before updating (use Git!). See https://hydephp.com/docs/master/updating-hyde for the upgrade guide.

Resources

Changelog

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

Contributing

HydePHP is an open-source project, contributions are very welcome!

Development is made in the HydePHP Monorepo, which you can find here https://github.com/hydephp/develop.

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