3 Hyde is a brazen two-column [hugo](https://gohugo.io) theme based on the [Jekyll](http://jekyllrb.com) theme of the same name.
4 It pairs a prominent sidebar with uncomplicated content.
6 ![Hyde screenshot](https://f.cloud.github.com/assets/98681/1831228/42af6c6a-7384-11e3-98fb-e0b923ee0468.png)
11 - [Installation](#installation)
13 - [Sidebar menu](#sidebar-menu)
14 - [Sticky sidebar content](#sticky-sidebar-content)
16 - [Reverse layout](#reverse-layout)
18 - [Google Analytics](#google-analytics)
20 - [Ported by](#ported-by)
28 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.
30 _[Forestry](https://forestry.io) Starter-Kit:_
32 [![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)
34 ### Standard Installation
36 To install Hyde as your default theme, first install this repository in the `themes/` directory:
39 $ git clone https://github.com/spf13/hyde.git
41 Second, specify `hyde` as your default theme in the `config.toml` file. Just add the line
45 at the top of the file.
50 Hyde includes some customizable options, typically applied via classes on the `<body>` element.
55 Create a list of nav links in the sidebar by assigning "menu=main" in the front matter.
58 ### Sticky sidebar content
60 By default Hyde ships with a sidebar that affixes it's content to the bottom of the sidebar. You can optionally disabled this by removing the `.sidebar-sticky` class from the sidebar's `.container`. Sidebar content will then normally flow from top to bottom.
63 <!-- Default sidebar -->
65 <div class="container sidebar-sticky">
70 <!-- Modified sidebar -->
72 <div class="container">
81 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).
83 ![Hyde in red](https://f.cloud.github.com/assets/98681/1831229/42b0b354-7384-11e3-8462-31b8df193fe5.png)
85 There are eight themes available at this time.
87 ![Hyde theme classes](https://f.cloud.github.com/assets/98681/1817044/e5b0ec06-6f68-11e3-83d7-acd1942797a1.png)
89 To use a theme, add the `themeColor` variable under `params`, like so:
96 themeColor = "theme-base-09"
104 themeColor: "theme-base-09"
107 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.
111 ![Hyde with reverse layout](https://f.cloud.github.com/assets/98681/1831230/42b0d3ac-7384-11e3-8d54-2065afd03f9e.png)
113 To reverse page orientation, add the `layoutReverse` variable under `params`, like so:
133 You can optionally enable a comment system powered by Disqus for the posts. Simply add the variable `disqusShortname` to your config file.
137 disqusShortname = "spf13"
142 disqusShortname : spf13
145 > **Note:** Previous version 1.0 the Disqus shortname had to be defined inside the `[params]` block.
150 Google Analytics can be enabled by assigning your tracking code to the `googleAnalytics` variable in the config file:
154 googleAnalytics = "Your tracking code"
159 googleAnalytics: Your tracking code
164 - <https://github.com/mdo>
165 - <https://twitter.com/mdo>
169 - <https://github.com/spf13>
170 - <https://twitter.com/spf13>
174 Open sourced under the [MIT license](LICENSE.md).