hugo-theme-hyde-hyde/README.md

79 lines
3 KiB
Markdown
Raw Normal View History

# hyde-hyde
2014-04-26 22:25:13 +00:00
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).
2018-01-21 14:17:19 +00:00
2018-07-21 23:33:29 +00:00
## Breaking Changes
2018-04-09 03:02:19 +00:00
2018-07-21 23:33:29 +00:00
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/blob/master/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 compatibility)
* The layouts have been heavily restructured and modularised further (see [_layouts_](https://github.com/htr3n/hyde-hyde/blob/master/layouts))
* Adding '[_Portfolio_](https://github.com/htr3n/hyde-hyde/blob/master/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.
2014-04-26 22:25:13 +00:00
Some screenshots:
![hyde-hyde main screen](https://github.com/htr3n/hyde-hyde/blob/master/images/main.png)
2014-04-26 22:25:13 +00:00
2018-07-04 23:50:28 +00:00
![A post in hyde-hyde](https://github.com/htr3n/hyde-hyde/blob/master/images/post.png)
2014-04-26 22:25:13 +00:00
![Portfolio hyde-hyde](https://github.com/htr3n/hyde-hyde/blob/master/images/portfolio.png)
2016-07-26 12:27:07 +00:00
## Installation
2018-07-21 23:33:29 +00:00
__`Hyde-hyde`__ can be easily installed as many other Hugo themes:
2016-07-26 12:27:07 +00:00
```sh
2018-07-21 23:33:29 +00:00
$ cd HUGO_PROJECT
# then either clone hyde-hyde
$ git clone https://github.com/htr3n/hyde-hyde.git themes/hyde-hyde
2018-07-21 23:33:29 +00:00
# or just add hyde-hyde as a submodule
$ git submodule add https://github.com/htr3n/hyde-hyde.git themes/hyde-hyde
2014-04-26 22:25:13 +00:00
```
2018-07-21 23:33:29 +00:00
After that, choose `hyde-hyde` as the main theme.
2014-04-26 22:25:13 +00:00
* `config.toml`
2014-04-26 22:25:13 +00:00
2018-07-21 23:33:29 +00:00
```toml
2018-01-21 11:50:25 +00:00
theme = "hyde-hyde"
```
2018-01-21 14:17:19 +00:00
* `config.yaml`
2014-04-26 22:25:13 +00:00
2018-01-21 11:50:25 +00:00
```yaml
theme : "hyde-hyde"
2014-04-26 22:25:13 +00:00
```
That's all. You can render your site using `hugo` and see the template in action.
## Options
2018-07-21 23:33:29 +00:00
* __`Hyde-hyde`__ essentially inherits most of Hyde's [options](https://github.com/spf13/hyde#options).
2018-04-09 03:02:19 +00:00
## Customisations
2018-07-21 23:33:29 +00:00
* Most of the newly added customisations are in the files [_static-src/scss/hyde-hyde/\_customised.scss_](https://github.com/htr3n/hyde-hyde/blob/master/static-src/scss/hyde-hyde/_customised.scss) and [_static-src/scss/hyde-hyde/\_variables.scss_](https://github.com/htr3n/hyde-hyde/blob/master/static-src/scss/hyde-hyde/_variables.scss)
2018-07-07 00:14:01 +00:00
* The layouts for a single post or a list/table of content in [`hyde-hyde/layouts`](https://github.com/htr3n/hyde-hyde/blob/master/layouts) are modularised and can be changed easily.
2018-04-09 03:02:19 +00:00
## Author(s)
2018-07-07 00:14:01 +00:00
### Original Developed by Mark Otto
2014-04-26 22:25:13 +00:00
- <https://github.com/mdo>
- <https://twitter.com/mdo>
### Hugo's Hyde Ported by Steve Francia
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).