Giter VIP home page Giter VIP logo

hyde's Introduction

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

hyde's People

Contributors

watzon avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

hyde's Issues

Error: can't find file 'zip'

shards install && crystal build ./src/hyde.cr --error-trace
Resolving dependencies
Fetching https://github.com/at-grandpa/clim.git
Fetching https://github.com/techmagister/liquid.cr.git
Fetching https://github.com/phoffer/inflector.cr.git
Fetching https://github.com/crystal-lang/json_mapping.cr.git
Shard "inflector" version (0.1.8) doesn't match tag version (1.0.0)
Using inflector (1.0.0)
Using json_mapping (0.1.1)
Using liquid (0.4.1)
Using clim (0.9.0)
In src/hyde.cr:3:1

 3 | require "zip"
     ^
Error: can't find file 'zip'

If you're trying to require a shard:
- Did you remember to run `shards install`?
- Did you make sure you're running the compiler in the same directory as your shard.yml?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.