hugo-theme-hyde-hyde/README.md

# 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.
It pairs a prominent sidebar with uncomplicated content.

![Hyde screenshot](https://f.cloud.github.com/assets/98681/1831228/42af6c6a-7384-11e3-98fb-e0b923ee0468.png)


## Contents

- [Installation](#installation)
- [Options](#options)
  - [Sidebar menu](#sidebar-menu)
  - [Sticky sidebar content](#sticky-sidebar-content)
  - [Themes](#themes)
  - [Reverse layout](#reverse-layout)
  - [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 `<body>` element.


### Sidebar menu

Create a list of nav links in the sidebar by assigning "menu=main" in the front matter.


### Sticky sidebar content

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.

```html
<!-- Default sidebar -->
<div class="sidebar">
  <div class="container sidebar-sticky">
    ...
  </div>
</div>

<!-- Modified sidebar -->
<div class="sidebar">
  <div class="container">
    ...
  </div>
</div>
```


### Themes

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).

![Hyde in red](https://f.cloud.github.com/assets/98681/1831229/42b0b354-7384-11e3-8462-31b8df193fe5.png)

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:

**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.

### Reverse layout

![Hyde with reverse layout](https://f.cloud.github.com/assets/98681/1831230/42b0d3ac-7384-11e3-8d54-2065afd03f9e.png)

To reverse page orientation, add the `layoutReverse` variable under `params`, like so:

**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 the `params` in your config file.

**TOML**
```toml
[params]
  disqusShortname = "spf13"
```

**YAML**
```yaml
params:
  disqusShortname: "spf13"
```

## Author
**Mark Otto**
- <https://github.com/mdo>
- <https://twitter.com/mdo>

## Ported By
**Steve Francia**
- <https://github.com/spf13>
- <https://twitter.com/spf13>

## License

Open sourced under the [MIT license](LICENSE.md).

<3
Adding the hyde theme 2014-04-26 22:25:13 +00:00			`# 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.`
			`It pairs a prominent sidebar with uncomplicated content.`

			`![Hyde screenshot](https://f.cloud.github.com/assets/98681/1831228/42af6c6a-7384-11e3-98fb-e0b923ee0468.png)`


			`## Contents`

Add installation section 2016-07-26 12:27:07 +00:00			`- [Installation](#installation)`
Adding the hyde theme 2014-04-26 22:25:13 +00:00			`- [Options](#options)`
			`- [Sidebar menu](#sidebar-menu)`
			`- [Sticky sidebar content](#sticky-sidebar-content)`
			`- [Themes](#themes)`
			`- [Reverse layout](#reverse-layout)`
Added Disqus support 2015-07-17 10:21:50 +00:00			`- [Disqus](#disqus)`
Adding the hyde theme 2014-04-26 22:25:13 +00:00			`- [Author](#author)`
small tweak to hyde read me 2014-04-26 22:41:16 +00:00			`- [Ported by](#ported-by)`
Adding the hyde theme 2014-04-26 22:25:13 +00:00			`- [License](#license)`


Add installation section 2016-07-26 12:27:07 +00:00			`## 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.`


Adding the hyde theme 2014-04-26 22:25:13 +00:00			`## Options`

			Hyde includes some customizable options, typically applied via classes on the `<body>` element.


			`### Sidebar menu`

			`Create a list of nav links in the sidebar by assigning "menu=main" in the front matter.`


			`### Sticky sidebar content`

			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.

			```html
			`<!-- Default sidebar -->`
			`<div class="sidebar">`
			`<div class="container sidebar-sticky">`
			`...`
			`</div>`
			`</div>`

			`<!-- Modified sidebar -->`
			`<div class="sidebar">`
			`<div class="container">`
			`...`
			`</div>`
			`</div>`
			```


			`### Themes`

			`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).`

			`![Hyde in red](https://f.cloud.github.com/assets/98681/1831229/42b0b354-7384-11e3-8462-31b8df193fe5.png)`

			`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)`

Updated README 2015-07-15 10:19:53 +00:00			To use a theme, add the `themeColor` variable under `params`, like so:
Adding the hyde theme 2014-04-26 22:25:13 +00:00
Added an option change the theme globally in the configs 2015-06-02 17:14:54 +00:00			`TOML`
			```toml
			`theme = "hyde"`

			`[params]`
			`themeColor = "theme-base-09"`
			```

			`YAML`
Updated README 2015-07-15 10:19:53 +00:00			```yaml
Added an option change the theme globally in the configs 2015-06-02 17:14:54 +00:00			`theme: "hyde"`
Updated README 2015-07-15 10:19:53 +00:00
Added an option change the theme globally in the configs 2015-06-02 17:14:54 +00:00			`params:`
			`themeColor: "theme-base-09"`
Adding the hyde theme 2014-04-26 22:25:13 +00:00			```

			`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.`

			`### Reverse layout`

			`![Hyde with reverse layout](https://f.cloud.github.com/assets/98681/1831230/42b0d3ac-7384-11e3-8d54-2065afd03f9e.png)`

Add configuration to Reverse layout 2016-03-08 22:15:24 +00:00			To reverse page orientation, add the `layoutReverse` variable under `params`, like so:
Adding the hyde theme 2014-04-26 22:25:13 +00:00
Add configuration to Reverse layout 2016-03-08 22:15:24 +00:00			`TOML`
			```toml
			`theme = "hyde"`

			`[params]`
			`layoutReverse = true`
			```

			`YAML`
			```yaml
			`theme: "hyde"`

			`params:`
			`layoutReverse: true`
Adding the hyde theme 2014-04-26 22:25:13 +00:00			```

Added Disqus support 2015-07-17 10:21:50 +00:00			`### 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"`
			```

Adding the hyde theme 2014-04-26 22:25:13 +00:00			`## Author`
			`Mark Otto`
			`- <https://github.com/mdo>`
			`- <https://twitter.com/mdo>`

			`## Ported By`
			`Steve Francia`
			`- <https://github.com/spf13>`
			`- <https://twitter.com/spf13>`

			`## License`

			`Open sourced under the [MIT license](LICENSE.md).`

			`<3`