-
Notifications
You must be signed in to change notification settings - Fork 741
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
6211421
commit f3c9a53
Showing
4 changed files
with
31 additions
and
113 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,118 +1,36 @@ | ||
| # Hyde | ||
| # Hydeout | ||
|
|
||
| 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. | ||
| Hydeout updates the original [Hyde](https://github.com/poole/hyde) | ||
| theme for [Jekyll](http://jekyllrb.com) 3.x and adds new functionality. | ||
|
|
||
|  | ||
| ### Usage | ||
|
|
||
| Hydeout currently isn't available as a Ruby Gem. I recommend just forking | ||
| it at the moment | ||
|
|
||
| ## Contents | ||
| ### Keep It Simple | ||
|
|
||
| - [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) | ||
| In keeping with the original Hyde theme, Hydeout avoids using | ||
| Javascript and aims to keep the overall design lightweight and plugin-free. | ||
|
|
||
| It updates Hyde's styling to incorporate the latest SASS files from | ||
| [Poole](https://getpoole.com) and replaces class-based theming with the use | ||
| of the following SASS variables: | ||
|
|
||
| ## 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 `<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](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 | ||
| <!-- 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](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 `<body>` element in the `default.html` layout, like so: | ||
|
|
||
| ```html | ||
| <body class="theme-base-08"> | ||
| ... | ||
| </body> | ||
| ```scss | ||
| $sidebar-bg-color: #202020 !default; | ||
| $sidebar-sticky: true !default; | ||
| $layout-reverse: false !default; | ||
| ``` | ||
|
|
||
| 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 | ||
| <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 submitted against `master`.** | ||
| - `gh-pages` for our hosted site, which includes our analytics tracking code. **Please avoid using this branch.** | ||
|
|
||
|
|
||
| ## Author | ||
|
|
||
| **Mark Otto** | ||
| - <https://github.com/mdo> | ||
| - <https://twitter.com/mdo> | ||
|
|
||
| ### New Features | ||
|
|
||
| ## License | ||
| It also adds a new tags page (accessible in the sidebar) and a new | ||
| "category" layout for dedicated category pages. | ||
|
|
||
| Open sourced under the [MIT license](LICENSE.md). | ||
| Category pages are automatically added to the sidebar. All other pages | ||
| must have `sidebar_link: true` in their front matter to show up in | ||
| the sidebar. | ||
|
|
||
| <3 | ||
| There's also a bunch of minor tweaks and adjustments throughout the | ||
| theme. Hope this works for you! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters