X-Git-Url: https://njoseph.me/gitweb/hyde.git/blobdiff_plain/5a4a5b1862047eec1ab6054528f41448e7004c8b..e199c3b532f168a2f65e91970544fd7782e133cb:/README.md diff --git a/README.md b/README.md index 6f0a8b2..45ee21f 100644 --- a/README.md +++ b/README.md @@ -8,17 +8,32 @@ It pairs a prominent sidebar with uncomplicated content. ## Contents +- [Installation](#installation) - [Options](#options) - [Sidebar menu](#sidebar-menu) - [Sticky sidebar content](#sticky-sidebar-content) - [Themes](#themes) - [Reverse layout](#reverse-layout) -- [Development](#development) + - [Disqus](#disqus) - [Author](#author) - [Ported by](#ported-by) - [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. @@ -60,12 +75,22 @@ 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: +To use a theme, add the `themeColor` variable under `params`, like so: -```html - - ... - +**TOML** +```toml +theme = "hyde" + +[params] + themeColor = "theme-base-09" +``` + +**YAML** +```yaml +theme: "hyde" + +params: + themeColor: "theme-base-09" ``` 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. @@ -74,16 +99,41 @@ 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 ``` -## Author +**YAML** +```yaml +theme: "hyde" + +params: + layoutReverse: true +``` + +### Disqus +You can optionally enable a comment system powered by Disqus for the posts. Simply add the variable `disqusShortname` to the `params` in your config file. + +**TOML** +```toml +[params] + disqusShortname = "spf13" +``` + +**YAML** +```yaml +params: + disqusShortname: "spf13" +``` + +## Author **Mark Otto** - -