hugo-theme-hyde-hyde/README.md

# hyde-hyde

__`Hyde-hyde`__ is a [Hugo](https://gohugo.io)'s theme inspired and derived from @spf13's [Hyde](https://github.com/spf13/hyde.git) and its variant [Nate Finch's blog](https://npf.io). 

## Breaking Changes

Since version 2.0, __`hyde-hyde`__ has been overhauled and, therefore, might cause some disruptions.

* The main styles are refactored and redeveloped using SCSS (see [_static-src/scss_](https://github.com/htr3n/hyde-hyde/tree/v2.0.0/static-src/scss)),  `poole.css` and `hyde.css` are no longer needed because `hyde-hyde.scss` already incorporates relevant elements (I still keep them there for reference purpose)
* The layouts have been heavily restructured and modularised further (see [_layouts_](https://github.com/htr3n/hyde-hyde/tree/v2.0.0/layouts))
* Adding '[_Portfolio_](https://github.com/htr3n/hyde-hyde/tree/v2.0.0/layouts/portfolio)' page inspired by Xiaoying Riley (@3rdwave_themes) [Developer-Theme](https://github.com/xriley/developer-theme)
* Switching to use system fonts instead of Web fonts (e.g. privacy issues)

For more details, please refer to [CHANGELOG](CHANGELOG.md). 

A real site in action can be found [here](https://htr3n.github.io) and its [WIP source](https://github.com/htr3n/htr3n-blog) for reference.

## Some Screenshots

### Main page

![hyde-hyde main screen](https://github.com/htr3n/hyde-hyde/raw/master/images/main.png)

### Post

![A post in hyde-hyde](https://github.com/htr3n/hyde-hyde/raw/master/images/post.png)

### Portfolio

![Portfolio hyde-hyde](https://github.com/htr3n/hyde-hyde/raw/master/images/portfolio.png)

## Installation

__`Hyde-hyde`__ can be easily installed as many other Hugo themes:

```sh
$ cd HUGO_PROJECT

# then either clone hyde-hyde
$ git clone https://github.com/htr3n/hyde-hyde.git themes/hyde-hyde

# or just add hyde-hyde as a submodule
$ git submodule add https://github.com/htr3n/hyde-hyde.git themes/hyde-hyde
```

After that, choose `hyde-hyde` as the main theme.

* `config.toml` 

```toml
theme = "hyde-hyde"
```

* `config.yaml`

```yaml
theme : "hyde-hyde"
```

That's all. You can render your site using `hugo` and see the template in action.

## Options

* __`Hyde-hyde`__ essentially inherits most of Hyde's [options](https://github.com/spf13/hyde#options).

## Customisations

* Most of the customisable SCSS styles in [_static-src/scss/hyde-hyde_](https://github.com/htr3n/hyde-hyde/tree/v2.0.0/static-src/scss/hyde-hyde) and layouts in [_hyde-hyde/layouts_](https://github.com/htr3n/hyde-hyde/tree/v2.0.0/layouts) are modularised and can be altered/adapted easily.

## Author(s)

### Original Developed by Mark Otto

- <https://github.com/mdo>
- <https://twitter.com/mdo>

### Hugo's Hyde Ported by Steve Francia
- <https://github.com/spf13>
- <https://twitter.com/spf13>

## License

Open sourced under the [MIT license](LICENSE.md).
adapt to npf.io themes and add social stuffs 2018-01-21 11:09:55 +00:00			`# hyde-hyde`
Adding the hyde theme 2014-04-26 22:25:13 +00:00
revamps styles and layouts 2018-07-21 23:33:29 +00:00			__`Hyde-hyde`__ is a [Hugo](https://gohugo.io)'s theme inspired and derived from @spf13's [Hyde](https://github.com/spf13/hyde.git) and its variant [Nate Finch's blog](https://npf.io).
revise link to Hyde's options 2018-01-21 14:17:19 +00:00
revamps styles and layouts 2018-07-21 23:33:29 +00:00			`## Breaking Changes`
Adds more guidance to README 2018-04-09 03:02:19 +00:00
revamps styles and layouts 2018-07-21 23:33:29 +00:00			Since version 2.0, __`hyde-hyde`__ has been overhauled and, therefore, might cause some disruptions.

revises README and config.toml 2018-07-27 02:19:40 +00:00			* The main styles are refactored and redeveloped using SCSS (see [_static-src/scss_](https://github.com/htr3n/hyde-hyde/tree/v2.0.0/static-src/scss)), `poole.css` and `hyde.css` are no longer needed because `hyde-hyde.scss` already incorporates relevant elements (I still keep them there for reference purpose)
revises README and CHANGELOG 2018-07-22 09:28:57 +00:00			`* The layouts have been heavily restructured and modularised further (see [_layouts_](https://github.com/htr3n/hyde-hyde/tree/v2.0.0/layouts))`
			`* Adding '[_Portfolio_](https://github.com/htr3n/hyde-hyde/tree/v2.0.0/layouts/portfolio)' page inspired by Xiaoying Riley (@3rdwave_themes) [Developer-Theme](https://github.com/xriley/developer-theme)`
revamps styles and layouts 2018-07-21 23:33:29 +00:00			`* Switching to use system fonts instead of Web fonts (e.g. privacy issues)`

			`For more details, please refer to [CHANGELOG](CHANGELOG.md).`

			`A real site in action can be found [here](https://htr3n.github.io) and its [WIP source](https://github.com/htr3n/htr3n-blog) for reference.`
Adding the hyde theme 2014-04-26 22:25:13 +00:00
fixes image links in README 2018-07-23 02:22:42 +00:00			`## Some Screenshots`
Updates to sync with code changes * Changes 'custom.css' to 'hyde-hyde.css' * Adds some explanation texts 2018-07-07 00:09:34 +00:00
fixes image links in README 2018-07-23 02:22:42 +00:00			`### Main page`
Adding the hyde theme 2014-04-26 22:25:13 +00:00
revises README and config.toml 2018-07-27 02:19:40 +00:00			`![hyde-hyde main screen](https://github.com/htr3n/hyde-hyde/raw/master/images/main.png)`
Adding the hyde theme 2014-04-26 22:25:13 +00:00
fixes image links in README 2018-07-23 02:22:42 +00:00			`### Post`

revises README and config.toml 2018-07-27 02:19:40 +00:00			`![A post in hyde-hyde](https://github.com/htr3n/hyde-hyde/raw/master/images/post.png)`
fixes image links in README 2018-07-23 02:22:42 +00:00
			`### Portfolio`

revises README and config.toml 2018-07-27 02:19:40 +00:00			`![Portfolio hyde-hyde](https://github.com/htr3n/hyde-hyde/raw/master/images/portfolio.png)`
revises README, adds the portfolio picture 2018-07-21 23:51:27 +00:00
Add installation section 2016-07-26 12:27:07 +00:00			`## Installation`

revamps styles and layouts 2018-07-21 23:33:29 +00:00			__`Hyde-hyde`__ can be easily installed as many other Hugo themes:
Add installation section 2016-07-26 12:27:07 +00:00
adapt to npf.io themes and add social stuffs 2018-01-21 11:09:55 +00:00			```sh
revamps styles and layouts 2018-07-21 23:33:29 +00:00			`$ cd HUGO_PROJECT`

			`# then either clone hyde-hyde`
adapt to npf.io themes and add social stuffs 2018-01-21 11:09:55 +00:00			`$ git clone https://github.com/htr3n/hyde-hyde.git themes/hyde-hyde`
revamps styles and layouts 2018-07-21 23:33:29 +00:00
			`# or just add hyde-hyde as a submodule`
adapt to npf.io themes and add social stuffs 2018-01-21 11:09:55 +00:00			`$ git submodule add https://github.com/htr3n/hyde-hyde.git themes/hyde-hyde`
Adding the hyde theme 2014-04-26 22:25:13 +00:00			```

revamps styles and layouts 2018-07-21 23:33:29 +00:00			After that, choose `hyde-hyde` as the main theme.
Adding the hyde theme 2014-04-26 22:25:13 +00:00
adapt to npf.io themes and add social stuffs 2018-01-21 11:09:55 +00:00			* `config.toml`
Adding the hyde theme 2014-04-26 22:25:13 +00:00
revamps styles and layouts 2018-07-21 23:33:29 +00:00			```toml
fix screenshots' path 2018-01-21 11:50:25 +00:00			`theme = "hyde-hyde"`
			```
revise link to Hyde's options 2018-01-21 14:17:19 +00:00
adapt to npf.io themes and add social stuffs 2018-01-21 11:09:55 +00:00			* `config.yaml`
Adding the hyde theme 2014-04-26 22:25:13 +00:00
fix screenshots' path 2018-01-21 11:50:25 +00:00			```yaml
adapt to npf.io themes and add social stuffs 2018-01-21 11:09:55 +00:00			`theme : "hyde-hyde"`
Adding the hyde theme 2014-04-26 22:25:13 +00:00			```

Updates to sync with code changes * Changes 'custom.css' to 'hyde-hyde.css' * Adds some explanation texts 2018-07-07 00:09:34 +00:00			That's all. You can render your site using `hugo` and see the template in action.

adapt to npf.io themes and add social stuffs 2018-01-21 11:09:55 +00:00			`## Options`
Add Google Analytics support Closes #44 2017-09-07 19:56:31 +00:00
revamps styles and layouts 2018-07-21 23:33:29 +00:00			* __`Hyde-hyde`__ essentially inherits most of Hyde's [options](https://github.com/spf13/hyde#options).
Add Google Analytics support Closes #44 2017-09-07 19:56:31 +00:00
Adds more guidance to README 2018-04-09 03:02:19 +00:00			`## Customisations`

revises CHANGELOG and README 2018-07-25 02:26:22 +00:00			`* Most of the customisable SCSS styles in [_static-src/scss/hyde-hyde_](https://github.com/htr3n/hyde-hyde/tree/v2.0.0/static-src/scss/hyde-hyde) and layouts in [_hyde-hyde/layouts_](https://github.com/htr3n/hyde-hyde/tree/v2.0.0/layouts) are modularised and can be altered/adapted easily.`
Adds more guidance to README 2018-04-09 03:02:19 +00:00
adapt to npf.io themes and add social stuffs 2018-01-21 11:09:55 +00:00			`## Author(s)`
Adds link to resources 2018-07-07 00:14:01 +00:00
adapt to npf.io themes and add social stuffs 2018-01-21 11:09:55 +00:00			`### Original Developed by Mark Otto`
Add Google Analytics support Closes #44 2017-09-07 19:56:31 +00:00
Adding the hyde theme 2014-04-26 22:25:13 +00:00			`- <https://github.com/mdo>`
			`- <https://twitter.com/mdo>`

adapt to npf.io themes and add social stuffs 2018-01-21 11:09:55 +00:00			`### Hugo's Hyde Ported by Steve Francia`
Adding the hyde theme 2014-04-26 22:25:13 +00:00			`- <https://github.com/spf13>`
			`- <https://twitter.com/spf13>`

			`## License`

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