X-Git-Url: https://njoseph.me/gitweb/hyde.git/blobdiff_plain/a04b9e15746f679a3a6d8f325b82e2392b20d380..5814b3e80c17336f1b02c3666914fd1445d31378:/README.md diff --git a/README.md b/README.md index 0235f16..d8cb82c 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,33 @@ 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) - [Disqus](#disqus) + - [Google Analytics](#google-analytics) - [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. @@ -104,18 +120,33 @@ params: ### 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. +You can optionally enable a comment system powered by Disqus for the posts. Simply add the variable `disqusShortname` to your config file. **TOML** ```toml -[params] - disqusShortname = "spf13" +disqusShortname = "spf13" ``` **YAML** ```yaml -params: - disqusShortname: "spf13" +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