Skip to content

Latest commit

 

History

History
64 lines (44 loc) · 2.3 KB

README.md

File metadata and controls

64 lines (44 loc) · 2.3 KB
Raw

Hyde

Hyde is a Crystal's answer to gems like Jekyll and Middleman; a static site generator built around pluggability, ease of use, and speed. WIth Hyde everything is based around plugins including the HTML generation, allowing you to pick and choose what pieces you want for your site. What a concept, right? Hyde comes in two parts; the core and the CLI.

Hyde Core

The core does all the behind the scenes work. It is the unsung hero of your Hyde install. You are only really going to worry about the Hyde Core if you're building a Hyde extension. Extension developers will hook into the Hyde::Extensions module to register their extension and then extend the Hyde::Extension class in order to hook into the build pipeline.

Hyde CLI

The Hyde CLI is what most people will be interacting with, as it provides an easy way to generate and interact with your site. The CLI comes with these commands, but others may be added by extensions:

  • hyde new - generates a new Hyde static site using the defaut template located here
  • hyde build - build your static site
  • hyde deploy - use your deployment config to deploy your Hyde site
  • hyde serve - use the built in development server to run your Hyde site locally

Installation

Note: To install Hyde you will need to have Crystal installed. See the install instructions here for information on how to do that.

To install hyde just make sure you have crystal and shards installed then run

shards install watzon/hyde

You can also always clone this repo and install it like that

git clone https://github.com/watzon/hyde.git
cd hyde
shards install
crystal build ./src/hyde.cr

Roadmap

TODO: Put a roadmap here

Extensions Needed

  • sass (probably using libsass)
  • il8n
  • webpack
  • cache buster
  • image optimization
  • feed generation
  • seo
  • sitemap generation
  • blog
  • emojis

Contributing

  1. Fork it (https://github.com/watzon/hyde/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors