X-Git-Url: https://njoseph.me/gitweb/hyde.git/blobdiff_plain/6fdb7f9d4b5932fb7fbf6fcf4c61bf9e7b7bf584..8349cf1aa1bf4675ba10bc47882a7fb089a54ceb:/README.md diff --git a/README.md b/README.md index 39b8d14..e318520 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Hyde -Hyde is a brazen two-column [hugo](http://hugo.spf13.com) theme based on the [Jekyll](http://jekyllrb.com) theme of the same name. +Hyde is a brazen two-column [hugo](https://gohugo.io) theme based on the [Jekyll](http://jekyllrb.com) theme of the same name. It pairs a prominent sidebar with uncomplicated content. ![Hyde screenshot](https://f.cloud.github.com/assets/98681/1831228/42af6c6a-7384-11e3-98fb-e0b923ee0468.png) @@ -8,6 +8,7 @@ It pairs a prominent sidebar with uncomplicated content. ## Contents +- [Installation](#installation) - [Options](#options) - [Sidebar menu](#sidebar-menu) - [Sticky sidebar content](#sticky-sidebar-content) @@ -19,6 +20,20 @@ It pairs a prominent sidebar with uncomplicated content. - [License](#license) +## Installation + +To install Hyde as your default theme, first install this repository in the `themes/` directory: + + $ cd themes/ + $ git clone https://github.com/spf13/hyde.git + +Second, specify `hyde` as your default theme in the `config.toml` file. Just add the line + + theme = "hyde" + +at the top of the file. + + ## Options Hyde includes some customizable options, typically applied via classes on the `` element. @@ -84,12 +99,22 @@ To create your own theme, look to the Themes section of [included CSS file](http ![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. +To reverse page orientation, add the `layoutReverse` variable under `params`, like so: -```html - - ... - +**TOML** +```toml +theme = "hyde" + +[params] + layoutReverse = true +``` + +**YAML** +```yaml +theme: "hyde" + +params: + layoutReverse: true ``` ### Disqus