Define yourself through the following config variables in params:
author = "<name of the author>"
description = "Short description of the site"
motto = "author's motto or short description"
avatar = "<absolute path to avatar>" //Leaving the avatar variable unset displays svg avatars
After that, fill up the social variables at the end of the config file. This theme suports the following social sites: (The examples are given)
github = "username"
email = "email@example.com"
twitter = "username"
facebook = "username"
youtube = "username"
medium = "username"
linkedin = "username"
stackoverflow = "number/username"
codepen = "username"
reddit = "username"
These variables have to be in the [social] table of config.toml or its equivalent for YAML or JSON.
github = "UtkarshVerma"
Toggling the views
As stated earlier, this theme has two views, Card view and Post view. To define your desired view, modify the contentType variable in params in the config file as follows:
contentType = "cards" #Enables the card view.
contentType = "posts" #Enables the post view.
One clear distinction between both the view is that Card view doesn’t support posts, instead it redirects to the specified link, while Post view does.
You may test them out yourselves by visiting my sites(stated above) which use them.
Also, post/card creation is done differently for both the views. It is as follows:
hugo new cards/example.md #Card creation
hugo new posts/example.md #Post creation
After this, just open your MarkDown card/post and provide the parameters for the card/post.
To enable setting images as background, you’ll have to disable random colour background first by setting enableColorBG to false.
Also, enabling image background feature requires the modification of two variables, namely bgImage and bgList. If you prefer a single image background, then simply set the value of bgImage as the absolute path of your image. For example,
bgImage = "/images/bg1.jpeg"
You can also enable random background feature which switches the background between a provided images list(stored in bgList), every time the site is reloaded. For example,
You may also add blurring effect to the background image using bgBlur.
You may configure your website based on the client device by using the isMobile JS variable. It is true when the client device is a mobile and vice versa.
Error page and about page
This theme supports total customization of about and error pages. These pages may be customized through the about.md and 404.md files. Once finished customizing, copy them in the /content directory of your Hugo site.
You may also set a custom favicon for your website using the favicon config variable. For example,
favicon = "/images/defaultFav.ico"
Shorte.st website script
The shorte.st website script has been implemented in this theme. To use it, you’ll first have to enable this feature by setting enableShortest to true and then setting the API Token you got from Shorte.st to shortestToken, and after that, define your domains as a list in the shortestDomains config variable.
Some other configurations
There are some other minor configurations as well. You may set them up by referring to the comments inside the config file.
The documentation for this repository is currently under work and is added to this repository’s wiki.
Wiki contributions are most welcome. Feel free to ask me about this theme’s features for that.
After finishing the configurations, you’re good to go. So, test your website using:
For testing the example site, you’ll have to explicitly specify the config file to Hugo. This is done as follows:
#For post view demo
hugo --config posts.toml server
#For card view demo
hugo --config cards.toml server
Found something interesting to add to this theme or rather a :beetle:bug? Let me know about it through the issue tracker. Pull requests are also welcome.
For more detailed instructions on how to contribute, refer to CONTRIBUTING.md