Giter Club home page Giter Club logo

hydejack's Introduction

Hydejack

Hydejack is a pretentious two-column Jekyll theme, stolen by @qwtel from Hyde. You could say it was.. hydejacked.

Features

Unlike Hyde, it's opinionated about how you are going to use it (as a blog!) Features included are:

  • Touch-enabled sidebar / drawer for mobile, including fallback when JS is disabled.
  • Github Pages compatible tag support based on this post.
  • Customizable link color and sidebar image, per-site, per-tag and per-post.
  • Optional author section at the bottom of each post.
  • Posts grouped by year on front and tag page.
  • Social media icons (github, twitter) on sidebar.
  • Optional comment section powered by Disqus.
  • Math blocks via KaTeX.

Download

Hydejack is developed on and hosted with GitHub. Head to the GitHub repository for downloads, bug reports, and feature requests.

Sidebar

I love the original Hyde theme, but unfortunately the layout isn't as great on small screens. Since the sidebar moves to the top, the user has to scroll just to read the title of a blog post.

By using a drawer component I was able to retain the original two column layout. It's possible to move the drawer via touch input (with the help of a little JavaScript).

Since the background image contributes to the feel of the page I'm letting it peek over the edge a bit. This also provides a hint to the user that an interaction is possible.

Manual

Configuration

You can configure important aspects of the theme via _config.yml. This includes:

  • the blog description in the sidebar
  • the (optional) author description and photo
  • default image and link color of the blog
  • the github and twitter usernames

How to Change the Image and Color of a Post

In the manifest of a blog post, simply add an url as image and a CSS color as color:

layout: post
title: Introducing Hydejack
image: http://qwtel.com/hydejack/public/img/hyde.jpg
color: '#949667'

How to Add a New Tag

Tags are not meant to be used #instagram #style: #food #goodfood #happy #happylife #didimentionfood #yougetthepoint, as each tag requires some setup work. I tend to think of it as categories that can be combined.

  1. Add an entry to _data/tags.yml, where the key represents a slug and provide at least a name value and optionally image, color and description.

    Example /_data/tags.yml:

    mytag:
      name: My Tag
  2. Make a new file in the tag folder, using the same name you've used as the key / slug and change the tag and permalink entries.

    Example /tag/mytag.md:

    layout: blog_by_tag
    tag: mytag
    permalink: /tag/mytag/
  3. Tag your blog posts using the tags key (color and image will only depend on the first tag).

    layout: post
    title: Introducing My New Tag
    tags: [mytag, othertag]
  4. (optional) Add the tag to the sidebar, by adding it to sidebar_tags in _config.yml. They will appear in the listed order.

    sidebar_tags: [mytag, othertag]

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.