[hyde.git] / README.md

# Hyde

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)


## 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

### 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 `<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 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
**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
da66ac19	2
01dd84d1	3	Hyde is a brazen two-column [hugo](https://gohugo.io) theme based on the [Jekyll](http://jekyllrb.com) theme of the same name.
da66ac19	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
fff9d5b2	11	- [Installation](#installation)
da66ac19	12	- [Options](#options)
	13	- [Sidebar menu](#sidebar-menu)
	14	- [Sticky sidebar content](#sticky-sidebar-content)
	15	- [Themes](#themes)
	16	- [Reverse layout](#reverse-layout)
62ef2ef0	17	- [Disqus](#disqus)
7cf2943e	18	- [Google Analytics](#google-analytics)
da66ac19	19	- [Author](#author)
5a4a5b18	20	- [Ported by](#ported-by)
da66ac19	21	- [License](#license)
	22
	23
fff9d5b2 PM	24	## Installation
fff9d5b2 PM	25
c0cdd0ea SE	26	### Quick Start
	27
	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.
	29
	30	_[Forestry](https://forestry.io) Starter-Kit:_
	31
	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)
	33
	34	### Standard Installation
	35
fff9d5b2 PM	36	To install Hyde as your default theme, first install this repository in the `themes/` directory:
	37
	38	$ cd themes/
	39	$ git clone https://github.com/spf13/hyde.git
	40
	41	Second, specify `hyde` as your default theme in the `config.toml` file. Just add the line
	42
	43	theme = "hyde"
	44
	45	at the top of the file.
	46
	47
da66ac19	48	## Options
	49
	50	Hyde includes some customizable options, typically applied via classes on the `<body>` element.
	51
	52
	53	### Sidebar menu
	54
	55	Create a list of nav links in the sidebar by assigning "menu=main" in the front matter.
	56
	57
	58	### Sticky sidebar content
	59
	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.
	61
	62	```html
	63	<!-- Default sidebar -->
	64	<div class="sidebar">
	65	<div class="container sidebar-sticky">
	66	...
	67	</div>
	68	</div>
	69
	70	<!-- Modified sidebar -->
	71	<div class="sidebar">
	72	<div class="container">
	73	...
	74	</div>
	75	</div>
	76	```
	77
	78
	79	### Themes
	80
	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).
	82
	83	![Hyde in red](https://f.cloud.github.com/assets/98681/1831229/42b0b354-7384-11e3-8462-31b8df193fe5.png)
	84
	85	There are eight themes available at this time.
	86
	87	![Hyde theme classes](https://f.cloud.github.com/assets/98681/1817044/e5b0ec06-6f68-11e3-83d7-acd1942797a1.png)
	88
a874cebd	89	To use a theme, add the `themeColor` variable under `params`, like so:
da66ac19	90
00eb7169	91	TOML
	92	```toml
	93	theme = "hyde"
	94
	95	[params]
	96	themeColor = "theme-base-09"
	97	```
	98
	99	YAML
a874cebd	100	```yaml
00eb7169	101	theme: "hyde"
a874cebd	102
00eb7169	103	params:
00eb7169	104	themeColor: "theme-base-09"
da66ac19	105	```
	106
	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.
	108
	109	### Reverse layout
	110
	111	![Hyde with reverse layout](https://f.cloud.github.com/assets/98681/1831230/42b0d3ac-7384-11e3-8d54-2065afd03f9e.png)
	112
a04b9e15	113	To reverse page orientation, add the `layoutReverse` variable under `params`, like so:
da66ac19	114
a04b9e15 JK	115	TOML
	116	```toml
	117	theme = "hyde"
	118
	119	[params]
	120	layoutReverse = true
	121	```
	122
	123	YAML
	124	```yaml
	125	theme: "hyde"
	126
	127	params:
	128	layoutReverse: true
da66ac19	129	```
da66ac19	130
62ef2ef0	131	### Disqus
62ef2ef0	132
7cf2943e	133	You can optionally enable a comment system powered by Disqus for the posts. Simply add the variable `disqusShortname` to your config file.
62ef2ef0	134
	135	TOML
	136	```toml
eab19740	137	disqusShortname = "spf13"
62ef2ef0	138	```
62ef2ef0	139
804cee45	140	YAML
	141	```yaml
	142	disqusShortname : spf13
	143	```
	144
eab19740	145	> Note: Previous version 1.0 the Disqus shortname had to be defined inside the `[params]` block.
62ef2ef0	146
7cf2943e	147
	148	## Google Analytics
	149
	150	Google Analytics can be enabled by assigning your tracking code to the `googleAnalytics` variable in the config file:
	151
	152	TOML
	153	```toml
	154	googleAnalytics = "Your tracking code"
	155	```
	156
	157	YAML
	158	```yaml
	159	googleAnalytics: Your tracking code
	160	```
	161
da66ac19	162	## Author
da66ac19	163	Mark Otto
	164	- <https://github.com/mdo>
	165	- <https://twitter.com/mdo>
	166
	167	## Ported By
	168	Steve Francia
	169	- <https://github.com/spf13>
	170	- <https://twitter.com/spf13>
	171
	172	## License
	173
	174	Open sourced under the [MIT license](LICENSE.md).
	175
	176	<3