Project

jekyll-theme-lanyon

4.32
No release in over 3 years
Low commit activity in last 3 years
jekyll-theme-lanyonpoole/lanyonHomepageDocumentationSource CodeBug Tracker
A reserved Jekyll theme that places the utmost gravity on content with a hidden drawer
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
6,192
Stars
3,249
Forks
2,584
Watchers
60
 Releases
Current version
1.1.0
Total releases
2
First release
2016-12-19
Latest release
2018-01-06
 Issues
Open Issues
24
Closed Issues
102
Total Issues
126
Issue Closure Rate
80%
 Pull Requests
Open Pull Requests
10
Closed Pull Requests
166
Merged Pull Requests
28
Pull Request Acceptance Rate
13%
 Development
Primary Language
CSS
Licenses
MIT
Average date of last 50 commits
2017-01-29
Reverse Dependencies
0

 Dependencies

Development

bundler
~> 1.13
rake
~> 12.0

Runtime

jekyll
~> 3.3
jekyll-feed
~> 0.9
jekyll-paginate
~> 1.1
jekyll-sitemap
~> 1.1
 Project Readme

Lanyon

Lanyon is an unassuming Jekyll theme that places content first by tucking away navigation in a hidden drawer. It's based on Poole, the Jekyll butler.

Lanyon Lanyon with open sidebar

Contents

  • Usage
  • Options
    • Sidebar menu
    • Themes
    • Reverse layout
  • Development
  • Author
  • License

Usage

Lanyon 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

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

Themes

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

Lanyon with red theme Lanyon with red theme and open sidebar

There are eight themes available at this time.

Available theme classes

To use a theme, add any one 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

Lanyon with reverse layout Lanyon with reverse layout and open sidebar

Reverse the page orientation with a single class.

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

Sidebar overlay instead of push

Make the sidebar overlap the viewport content with a single class:

<body class="sidebar-overlay">
  ...
</body>

This will keep the content stationary and slide in the sidebar over the side content. It also adds a box-shadow based outline to the toggle for contrast against backgrounds, as well as a box-shadow on the sidebar for depth.

It's also available for a reversed layout when you add both classes:

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

Sidebar open on page load

Show an open sidebar on page load by modifying the <input> tag within the sidebar.html layout to add the checked boolean attribute:

<input type="checkbox" class="sidebar-checkbox" id="sidebar-checkbox" checked>

Using Liquid you can also conditionally show the sidebar open on a per-page basis. For example, here's how you could have it open on the homepage only:

<input type="checkbox" class="sidebar-checkbox" id="sidebar-checkbox" {% if page.title =="Home" %}checked{% endif %}>

Development

Lanyon 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