Project

jekyll-theme-hyde-plus

0.0
No commit activity in last 3 years
No release in over 3 years
jekyll-theme-hyde-plusemmanuelcorrales/hyde-plusHomepageDocumentationSource CodeBug TrackerWiki
An improvement of the Jekyll theme Hyde.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
15,254
Stars
2
Forks
0
Watchers
1
 Releases
Current version
0.3.5
Total releases
9
First release
2018-05-13
Latest release
2018-05-27
 Development
Primary Language
CSS
Licenses
MIT
Average date of last 50 commits
2018-05-18
Reverse Dependencies
0

 Dependencies

Development

bundler
~> 1.16
rake
~> 12.0

Runtime

jekyll
~> 3.7
jekyll-feed
~> 0.9.3
jekyll-gist
~> 1.5.0
jekyll-paginate
~> 1.1.0
jekyll-seo-tag
~> 2.4.0
pygments.rb
>= 0
redcarpet
~> 3.4.0
 Project Readme

Hyde Plus

Hyde Plus is a fork of Hyde which is a brazen two-column Jekyll theme that pairs a prominent sidebar with uncomplicated content.

Hyde screenshot

Contents

  • Installation
  • Usage
  • Options
    • Sidebar menu
    • Sticky sidebar content
    • Themes
    • Reverse layout
  • Development
  • Authors
  • License

Installation

Add this line to your Jekyll site's Gemfile:

gem "jekyll-theme-hyde-plus"

And add this line to your Jekyll site's _config.yml:

theme: jekyll-theme-hyde-plus

And then execute:

$ bundle

Or install it yourself as:

$ gem install jekyll-theme-hyde-plus

Usage

Hyde Plus is a fork of Hyde, a theme built on top of Poole, which provides a fully furnished Jekyll setup—just download and start the Jekyll server. See the Poole usage guidelines for how to install and use Jekyll. Hyde Plus can do more than what Hyde can do.

Options

Hyde includes some customizable options, typically applied via classes on the <body> element.

Sidebar menu

Create a list of nav links in the sidebar by assigning each Jekyll page the correct layout in the page's front-matter.

---
layout: page
title: About
---

Why require a specific layout? Jekyll will return all pages, including the atom.xml, and with an alphabetical sort order. To ensure the first link is Home, we exclude the index.html page from this list by specifying the page layout.

Sticky sidebar content

By default Hyde ships with a sidebar that affixes it's content to the bottom of the sidebar. You can optionally disable this by removing the .sidebar-sticky class from the sidebar's .container. Sidebar content will then normally flow from top to bottom.

<!-- Default sidebar -->
<div class="sidebar">
  <div class="container sidebar-sticky">
    ...
  </div>
</div>

<!-- Modified sidebar -->
<div class="sidebar">
  <div class="container">
    ...
  </div>
</div>

Themes

Hyde ships with eight optional themes based on the base16 color scheme. Apply a theme to change the color scheme (mostly applies to sidebar and links).

Hyde in red

There are eight themes available at this time.

Hyde theme classes

To use a theme, add anyone of the available theme classes to the <body> element in the default.html layout, like so:

<body class="theme-base-08">
  ...
</body>

To create your own theme, look to the Themes section of included CSS file. Copy any existing theme (they're only a few lines of CSS), rename it, and change the provided colors.

Reverse layout

Hyde with reverse layout

Hyde's page orientation can be reversed with a single class.

<body class="layout-reverse">
  ...
</body>

Development

To set up your environment to develop this theme, run bundle install.

Your theme is setup just like a normal Jekyll site! To test your theme, run bundle exec jekyll serve and open your browser at http://localhost:4000. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.

When your theme is released, only the files in _layouts, _includes, _sass and assets tracked with Git will be bundled. To add a custom directory to your theme-gem, please edit the regexp in jekyll-theme-hyde-plus.gemspec accordingly.

Authors

Emmanuel Corrales

Mark Otto

License

Open sourced under the MIT license.