[hyde.git] / 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

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


## 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
Commit	Line	Data
da66ac19	1	# Hyde
	2
	3	Hyde is a brazen two-column [hugo](http://hugo.spf13.com) theme based on the [Jekyll](http://jekyllrb.com) theme of the same name.
	4	It pairs a prominent sidebar with uncomplicated content.
	5
	6	![Hyde screenshot](https://f.cloud.github.com/assets/98681/1831228/42af6c6a-7384-11e3-98fb-e0b923ee0468.png)
	7
	8
	9	## Contents
	10
da66ac19	11	- [Options](#options)
	12	- [Sidebar menu](#sidebar-menu)
	13	- [Sticky sidebar content](#sticky-sidebar-content)
	14	- [Themes](#themes)
	15	- [Reverse layout](#reverse-layout)
62ef2ef0	16	- [Disqus](#disqus)
da66ac19	17	- [Author](#author)
5a4a5b18	18	- [Ported by](#ported-by)
da66ac19	19	- [License](#license)
	20
	21
	22	## Options
	23
	24	Hyde includes some customizable options, typically applied via classes on the `<body>` element.
	25
	26
	27	### Sidebar menu
	28
	29	Create a list of nav links in the sidebar by assigning "menu=main" in the front matter.
	30
	31
	32	### Sticky sidebar content
	33
	34	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.
	35
	36	```html
	37	<!-- Default sidebar -->
	38	<div class="sidebar">
	39	<div class="container sidebar-sticky">
	40	...
	41	</div>
	42	</div>
	43
	44	<!-- Modified sidebar -->
	45	<div class="sidebar">
	46	<div class="container">
	47	...
	48	</div>
	49	</div>
	50	```
	51
	52
	53	### Themes
	54
	55	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).
	56
	57	![Hyde in red](https://f.cloud.github.com/assets/98681/1831229/42b0b354-7384-11e3-8462-31b8df193fe5.png)
	58
	59	There are eight themes available at this time.
	60
	61	![Hyde theme classes](https://f.cloud.github.com/assets/98681/1817044/e5b0ec06-6f68-11e3-83d7-acd1942797a1.png)
	62
a874cebd	63	To use a theme, add the `themeColor` variable under `params`, like so:
da66ac19	64
00eb7169	65	TOML
	66	```toml
	67	theme = "hyde"
	68
	69	[params]
	70	themeColor = "theme-base-09"
	71	```
	72
	73	YAML
a874cebd	74	```yaml
00eb7169	75	theme: "hyde"
a874cebd	76
00eb7169	77	params:
00eb7169	78	themeColor: "theme-base-09"
da66ac19	79	```
	80
	81	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.
	82
	83	### Reverse layout
	84
	85	![Hyde with reverse layout](https://f.cloud.github.com/assets/98681/1831230/42b0d3ac-7384-11e3-8d54-2065afd03f9e.png)
	86
a04b9e15	87	To reverse page orientation, add the `layoutReverse` variable under `params`, like so:
da66ac19	88
a04b9e15 JK	89	TOML
	90	```toml
	91	theme = "hyde"
	92
	93	[params]
	94	layoutReverse = true
	95	```
	96
	97	YAML
	98	```yaml
	99	theme: "hyde"
	100
	101	params:
	102	layoutReverse: true
da66ac19	103	```
da66ac19	104
62ef2ef0	105	### Disqus
	106
	107	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.
	108
	109	TOML
	110	```toml
	111	[params]
	112	disqusShortname = "spf13"
	113	```
	114
	115	YAML
	116	```yaml
	117	params:
	118	disqusShortname: "spf13"
	119	```
	120
da66ac19	121	## Author
da66ac19	122	Mark Otto
	123	- <https://github.com/mdo>
	124	- <https://twitter.com/mdo>
	125
	126	## Ported By
	127	Steve Francia
	128	- <https://github.com/spf13>
	129	- <https://twitter.com/spf13>
	130
	131	## License
	132
	133	Open sourced under the [MIT license](LICENSE.md).
	134
	135	<3