vbatts/hugo-theme-hyde-hyde
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Adds more guidance to README

Browse source
This commit is contained in:
Huy Tran 2018-04-09 13:02:19 +10:00 committed by GitHub
parent 6139c76987
commit 542907a4ac
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -2,19 +2,20 @@
__`hyde-hyde`__ is a [Hugo](https://gohugo.io)'s theme derived from @spf13's [Hyde](https://github.com/spf13/hyde.git) which is in turn ported from @mdo Jekyll's [Hyde](https://github.com/poole/hyde).
You can see a real site in action [here](https://htr3n.github.io).
## Notable Changes
* Restructuring/Modularising the layouts (`baseof.html`, `single.html`, `list.html` and the partials)
* Using [highlight.js](https://highlightjs.org) for highlighting code
* Using [Font-Awesome 5](https://fontawesome.com) for icons
* Using color tones inspired by [Nate Finch's blog](https://npf.io)
* Using main font [Fira-Sans](https://fonts.google.com/specimen/Fira+Sans) + fixed width font [Roboto Mono](https://fonts.google.com/specimen/Roboto+Mono)
* Adding [GraphComment](https://graphcomment.com) for replacing the built-in [Disqus](https://disqus.com)
A real site in action [here](https://htr3n.github.io).
![hyde-hyde main screen](https://github.com/htr3n/hyde-hyde/blob/master/images/main.png)
![hyde-hyde main screen](https://github.com/htr3n/hyde-hyde/blob/master/images/posts.png)
## Notable Changes
* Using [highlight.js](https://highlightjs.org) for highlighting code
* Using [Font-Awesome 5](https://fontawesome.com) for icons
* Color tones are inspired by [Nate Finch's blog](https://npf.io)
* Main font [Fira-Sans](https://fonts.google.com/specimen/Fira+Sans) + fixed width font [Roboto Mono](https://fonts.google.com/specimen/Roboto+Mono)
* Adding [GraphComment](https://graphcomment.com) for replacing Disqus
## Installation
`hyde-hyde` can be easily installed as many other Hugo's themes:
@ -45,6 +46,11 @@ theme : "hyde-hyde"
* `hyde-hyde` essentially inherits [all options](https://github.com/spf13/hyde#options) from Hyde.
## Customisations
* Most of the newly added customisations are in the file `hyde-hyde/static/css/custom.css`
* The layouts for a single post or a list/table of content in `hyde-hyde/layouts` are modularised and easily to changed
## Author(s)
### Original Developed by Mark Otto
@ -62,5 +68,3 @@ theme : "hyde-hyde"
## License
Open sourced under the [MIT license](LICENSE.md).