From f3c9a53e7d666d12c847e790b1b5ec80f8cb9361 Mon Sep 17 00:00:00 2001 From: Andrew Fong Date: Thu, 1 Jun 2017 03:49:23 -0700 Subject: [PATCH] Attribution --- CNAME | 1 - LICENSE.md | 1 + README.md | 130 ++++++++++------------------------------------------ _config.yml | 12 ++--- 4 files changed, 31 insertions(+), 113 deletions(-) delete mode 100644 CNAME diff --git a/CNAME b/CNAME deleted file mode 100644 index 77c1018ca7..0000000000 --- a/CNAME +++ /dev/null @@ -1 +0,0 @@ -hyde.getpoole.com \ No newline at end of file diff --git a/LICENSE.md b/LICENSE.md index c344d146f4..a697ee70e4 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,6 +1,7 @@ # Released under MIT License Copyright (c) 2013 Mark Otto. +Copyright (c) 2017 Andrew Fong. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: diff --git a/README.md b/README.md index 26fe63f053..ad571880cb 100644 --- a/README.md +++ b/README.md @@ -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. -![Hyde screenshot](https://f.cloud.github.com/assets/98681/1831228/42af6c6a-7384-11e3-98fb-e0b923ee0468.png) +### 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 `` 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). - -![Hyde in red](https://f.cloud.github.com/assets/98681/1831229/42b0b354-7384-11e3-8462-31b8df193fe5.png) - -There are eight themes available at this time. - -![Hyde theme classes](https://f.cloud.github.com/assets/98681/1817044/e5b0ec06-6f68-11e3-83d7-acd1942797a1.png) - -To use a theme, add anyone of the available theme classes to the `` element in the `default.html` layout, like so: - -```html - - ... - +```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 with reverse layout](https://f.cloud.github.com/assets/98681/1831230/42b0d3ac-7384-11e3-8d54-2065afd03f9e.png) - -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** -- -- - +### 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! diff --git a/_config.yml b/_config.yml index 3266557d5e..a5c63bf4fc 100644 --- a/_config.yml +++ b/_config.yml @@ -3,18 +3,18 @@ markdown: kramdown highlighter: rouge # Permalinks -permalink: pretty +permalink: /:year/:month/:day/:title.html # Setup -title: Hyde +title: Hydeout tagline: 'A Jekyll theme' -description: 'A brazen two-column Jekyll theme that pairs a prominent sidebar with uncomplicated content. Made by @mdo.' +description: 'The Hyde theme for Jekyll, updated.' url: http://hyde.getpoole.com baseurl: # the optional subpath of your site, e.g. "/blog" author: - name: 'Mark Otto' - url: https://twitter.com/mdo + name: 'Andrew Fong' + url: https://twitter.com/fongandrewc paginate: 5 defaults: @@ -33,4 +33,4 @@ gems: - jekyll-paginate github: - repo: https://github.com/poole/hyde + repo: https://github.com/fongandrew/hydeout