Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/poole/lanyon
A content-first, sliding sidebar theme for Jekyll.
https://github.com/poole/lanyon
jekyll jekyll-theme
Last synced: about 1 month ago
JSON representation
A content-first, sliding sidebar theme for Jekyll.
- Host: GitHub
- URL: https://github.com/poole/lanyon
- Owner: poole
- License: other
- Created: 2013-12-28T07:53:04.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-05-12T04:57:15.000Z (4 months ago)
- Last Synced: 2024-06-27T15:31:43.329Z (2 months ago)
- Topics: jekyll, jekyll-theme
- Language: CSS
- Homepage: http://lanyon.getpoole.com
- Size: 121 KB
- Stars: 3,224
- Watchers: 62
- Forks: 2,943
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-starred - poole/lanyon - A content-first, sliding sidebar theme for Jekyll. (jekyll-theme)
README
# Lanyon
Lanyon is an unassuming [Jekyll](http://jekyllrb.com) theme that places content first by tucking away navigation in a hidden drawer. It's based on [Poole](http://getpoole.com), the Jekyll butler.
## Contents
- [Usage](#usage)
- [Options](#options)
- [Sidebar menu](#sidebar-menu)
- [Themes](#themes)
- [Reverse layout](#reverse-layout)
- [Development](#development)
- [Author](#author)
- [License](#license)
## Usage
Lanyon is a theme built on top of [Poole](https://github.com/poole/poole), which provides a fully furnished Jekyll setup—just download and start the Jekyll server. See [the Poole usage guidelines](https://github.com/poole/poole#usage) for how to install and use Jekyll.
## Options
Lanyon includes some customizable options, typically applied via classes on the `` 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](http://jekyllrb.com/docs/frontmatter/).
```
---
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](https://github.com/chriskempson/base16). 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 any one of the available theme classes to the `` element in the `default.html` layout, like so:
```html
...
```
To create your own theme, look to the Themes section of [included CSS file](https://github.com/poole/lanyon/blob/master/public/css/lanyon.css). Copy any existing theme (they're only a few lines of CSS), rename it, and change the provided colors.
### Reverse layout
Reverse the page orientation with a single class.
```html
...
```
### Sidebar overlay instead of push
Make the sidebar overlap the viewport content with a single class:
```html
...
```
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:
```html
...
```
### Sidebar open on page load
Show an open sidebar on page load by modifying the `` tag within the `sidebar.html` layout to add the `checked` boolean attribute:
```html
```
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:
```html
```
## 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](LICENSE.md).
<3