serum

serum

Code Issues 0 Pull Requests 0 Wiki Pulse Graphs Settings SSH clone URL You can clone with HTTPS, SSH, or Subversion. Serum marries the utility of Jekyll Bootstrap with the flair of the Hyde theme.

Download

Serum

Serum marries the utility of Jekyll Bootstrap with the flair of the Hyde theme.

Prerequisites

  • A website built with Jekyll Bootstrap (and everything that this entails)

Usage

To use this theme, in the root of your website's repository, run:

rake theme:install git="https://github.com/avnestico/serum.git"

To clone this theme and modify it, from the parent folder of your website's repository, run:

git clone [email protected]:avnestico/serum.git
cd serum
git remote set-url [email protected]:USERNAME/serum.git
{{ make sure the above repo exists on GitHub }}
{{ make changes here }}
git push
cd ../USERNAME.github.io
rake theme:install git="https://github.com/USERNAME/serum.git"

Setup

Add the following to your _config.yml, changing the variables' values as necessary:

# Serum variables
baseurl: /

hyde:
  version: 2.1.0

github:
  repo: https://github.com/avnestico/avnestico.github.io

Optional: adding the following to your _config.yml enables pagination, as in the Hyde index page:

# Gems
gems: [jekyll-paginate]

paginate: 5

Optional: adding the following to your _config.yml makes your links look better:

# Permalinks
permalink: pretty

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.

Contents

Usage

Hyde is 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.

Options

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

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).

There are eight themes available at this time.

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's page orientation can be reversed with a single class.

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

Development

Hyde has two branches, but only one is used for active development.

  • master for development. All pull requests should be to submitted against master.
  • gh-pages for our hosted site, which includes our analytics tracking code. Please avoid using this branch.

Author

Mark Otto

License

Open sourced under the MIT license.

<3

minimalacademicresumeportfoliodocumentationwikitailwindbootstrapdarkecommercegithub-pagesblog