Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/algolia/algoliasearch-jekyll-hyde
A brazen two-column theme for Jekyll.
https://github.com/algolia/algoliasearch-jekyll-hyde
Last synced: 13 days ago
JSON representation
A brazen two-column theme for Jekyll.
- Host: GitHub
- URL: https://github.com/algolia/algoliasearch-jekyll-hyde
- Owner: algolia
- License: other
- Archived: true
- Fork: true (poole/hyde)
- Created: 2015-06-18T14:17:50.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-12-20T16:48:37.000Z (almost 7 years ago)
- Last Synced: 2024-04-11T05:18:23.355Z (7 months ago)
- Language: CSS
- Homepage: http://algolia.github.io/algoliasearch-jekyll-hyde
- Size: 16.3 MB
- Stars: 39
- Watchers: 43
- Forks: 24
- Open Issues: 0
-
Metadata Files:
- Readme: README-original.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Hyde
Hyde is a brazen two-column [Jekyll](http://jekyllrb.com) theme that pairs a prominent sidebar with uncomplicated content. It's based on [Poole](http://getpoole.com), the Jekyll butler.
## Contents
- [Usage](#usage)
- [Options](#options)
- [Sidebar menu](#sidebar-menu)
- [Sticky sidebar content](#sticky-sidebar-content)
- [Themes](#themes)
- [Reverse layout](#reverse-layout)
- [Development](#development)
- [Author](#author)
- [License](#license)
## Usage
Hyde 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
Hyde 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.
### 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.
```html
```
### Themes
Hyde 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 anyone 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/hyde/blob/master/public/css/hyde.css). 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.
```html
...
```
## Development
Hyde has two branches, but only one is used for active development.
- `master` for development. **All pull requests should be 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