Heidi¶ ↑
Heidi 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¶ ↑
Heidi 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¶ ↑
Heidi 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 Heidi 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¶ ↑
Heidi 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¶ ↑
Heidi's page orientation can be reversed with a single class.
<body class="layout-reverse"> ... </body>
Development¶ ↑
Heidi has two branches, but only one is used for active development.
-
master
for development. All pull requests should be submitted againstmaster
. -
gh-pages
for our hosted site, which includes our analytics tracking code. Please avoid using this branch.
Authors¶ ↑
Mark Otto - github.com/mdo - twitter.com/mdo Howlin Bash - gitlab.com/howlinbash - twitter.com/howlinbash
License¶ ↑
Open sourced under the MIT license.
<3