NOTICE: Maintainers / collaborators seeking: As I’m underwater with my full time job at the moment, I’m actively looking for and welcome any new maintainers or collaborators. If you are interested, comment on #130 and I can add you to the project. TIA.
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 assets/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)
Per PR [#45 by @jd4no, hyde-hyde can use SCSSs directly in the templates instead of the generated CSSs. The generated CSSs and the generated resources are still kept in hyde-hyde in order to ensure the demo on Hugo theme site working.
The layouts have been heavily restructured and modularised further (see layouts)
For more details, please refer to CHANGELOG. A real site in action can be found here and its WIP source for reference.
Hyde-hyde can be easily installed as many other Hugo themes:
$ 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.
theme = "hyde-hyde"
theme : "hyde-hyde"
That’s all. You can render your site using hugo and see hyde-hyde in action.
Hyde-hyde essentially inherits most of Hyde’s options. There are some extra options though
highlightjs = true: use highlight.js instead of Hugo built-in support for code highlighting
highlightjsstyle="highlight-style": only when highlightjs = true, please choose one of many highlight.js’s styles.
Since v2.0.1, highlighting for each page can be fine-tuned in the front matter, for example
highlight = false (default true)
highlightjslanguages = ["swift", "objectivec"]
postNavigation = true|false (default true): Setting to false will disable the navigation Previous Post/ Next Post
relatedPosts = false|true (default false): Setting to true allows related posts. Please refer here for more details on related contents with Hugo.
GraphCommentId = "your-graphcomment-id": to use GraphComment instead of the built-in Disqus. This option should be used exclusively with disqusShortname = "disqus-shortname".
UtterancesRepo = "owner/repo-name": to use Utterances instead of the built-in Disqus. This option should be used exclusively with disqusShortname = "disqus-shortname".
UtterancesIssueTerm = "pathname" Method for Utterances to match issue’s to posts (pathname, url, title, og:title)
UtterancesTheme = "github-light" Theme for Utterances (github-light, github-dark)
Commento = true: to use Commento instead of the built-in Disqus. This option should be used exclusively with disqusShortname = "disqus-shortname".
As I design the section portfolio to be rendered as list, _index.md can be used to set the title for your portfolio (you can read more about _index.mdhere). For instance, when I want to set the title of my portfolio “Projects”, the front matter of _index.md will be:
The remaining of _index.md will be ignored.
For each project, just create a Markdown file with the following parameters in the front matter:
title: "Project P1's Title"
description: "A short description"
Here is a longer summary of the project. You can write as long as you wish.
date is important to sort the project chronologically
layout 'portfolio' is important as you don’t want your project’s page appear in the list of posts in the main page of your Web site but only in the Portfolio ;)
featured: true : when you want to show a project as featured project. It is default to false. Note that only one project should be marked featured: true , otherwise, the result could be random as the Hugo template will take the first one.
The body of the Markdown file will be the summary of the project.
By default hugo will show in your home page the most populated section.
This means that if you have more projects than posts, by default your home page will list your projects instead of your posts.
If you want to change this behaviour you can change the mainsections.
For example, for the exampleSite this is how you should change the config.toml file: