diff options
| author | Huy Tran <hoang.huy.tran@gmail.com> | 2018-04-09 06:02:19 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-04-09 06:02:19 +0300 |
| commit | 542907a4ac079f66430dbf0679da9399476d70a9 (patch) | |
| tree | dc1a00fb87ca23e80380ca303e19856a9a9495b1 /README.md | |
| parent | 6139c76987303794481b6278450099d3b4618b71 (diff) | |
Adds more guidance to README
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 24 |
1 files changed, 14 insertions, 10 deletions
@@ -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).   -## 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). - - |