X-Git-Url: http://njoseph.me/gitweb/hyde.git/blobdiff_plain/cd672f87b773e7d7f0bd278fe2faa68a1e2ffc1f..HEAD:/README.md diff --git a/README.md b/README.md index 3233a15..04d9654 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,17 +8,43 @@ 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) + - [Google Analytics](#google-analytics) - [Author](#author) - [Ported by](#ported-by) - [License](#license) +## Installation + +### Quick Start + +To give you a running start this installation puts a fully configured [starter repo](https://github.com/forestryio/hyde-hugo-starter) into your Git account and sets it up in a content manager / CMS. + +_[Forestry](https://forestry.io) Starter-Kit:_ + +[![Import this project into Forestry](https://assets.forestry.io/import-to-forestry.svg)](https://app.forestry.io/quick-start?repo=forestryio/hyde-hugo-starter&provider=github&engine=hugo&version=0.49) + +### Standard 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,7 +86,7 @@ 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 the `themeColor` variable under `params``, like so: +To use a theme, add the `themeColor` variable under `params`, like so: **TOML** ```toml @@ -71,8 +97,9 @@ theme = "hyde" ``` **YAML** -``` +```yaml theme: "hyde" + params: themeColor: "theme-base-09" ``` @@ -83,12 +110,53 @@ 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 + +You can optionally enable a comment system powered by Disqus for the posts. Simply add the variable `disqusShortname` to your config file. + +**TOML** +```toml +disqusShortname = "spf13" +``` + +**YAML** +```yaml +disqusShortname : spf13 +``` + +> **Note:** Previous version 1.0 the Disqus shortname had to be defined inside the `[params]` block. + + +## Google Analytics + +Google Analytics can be enabled by assigning your tracking code to the `googleAnalytics` variable in the config file: + +**TOML** +```toml +googleAnalytics = "Your tracking code" +``` + +**YAML** +```yaml +googleAnalytics: Your tracking code ``` ## Author