Skip to content

maverickmac/hydeout

Repository files navigation

Hyde

Hyde is a brazen two-column Jekyll theme that pairs a prominent sidebar with uncomplicated content. It's based on Poole, the Jekyll butler.

Hyde screenshot

Installation

Requires Poole

To get started, download Poole. See the usage guidelines for how to install and get up and running with Jekyll and Poole.

Enabling Hyde

Copy over the included files to turn any vanilla Poole site into a Hyde site.

  • Replace _includes/ with the included folder of the same name (will replace _includes/head.html and add _includes/sidebar.html)
  • Replace _layouts/default.html with the included file of the same name
  • Move public/css/hyde.css to public/css/

Then, start up your Jekyll server and go!

Options

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

Sticky sidebar content

By default Hyde ships with a sidebar that affixes it's content to the bottom of the sidebar. You can optionally disabled 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>

Author

Mark Otto https://github.com/mdo https://twitter.com/mdo

License

Open sourced under the MIT license.

<3

About

A refreshed version of Hyde for Jekyll 3.x and 4.x

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • SCSS 56.4%
  • HTML 40.7%
  • Ruby 2.9%