4.5 KiB
weight, title, date, description, tags, type
| weight | title | date | description | tags | type | |||
|---|---|---|---|---|---|---|---|---|
| 15 | Theme Documentation - Advanced | 2020-05-06T21:29:01+08:00 | Discover how to maximise Gokarna's potential |
|
post |
Gokarna is an opinionated theme with a focus on minimalism and simplicity.
Content Types
This theme supports two types of content types: post and page. To specify them, you need to add them in your markdown metadata.
Post
This is the default blog post type which will be shown in your "Posts" section and who's tags will be indexed. Basically, a normal blog post.
---
title: "Hello, world!"
date: 2021-01-01
description: "A blog post"
image: "/path/to/image.png"
type: "post"
tags: ["blog"]
---
# Hello World!
This is my blog.
Page
We introduced this type to distinguish between blog posts and normal markdown pages. The reason to create this was to give the user complete freedom in creating their website. You can use this to create a portfolio of your projects or showcase your designs. The possibilites are endless and the choice is yours.
---
title: "Hello, world!"
image: "/path/to/image.png"
type: "page"
---
# Projects
Keep an eye on this space for my upcoming projects
Weights
The weight attribute can be added in the markdown metadata for post types. We have an option in our config.toml: params.showPostsOnHomePage which allows you to:
- Show popular posts on home page if the value is set to
popular. It sorts the all the posts by it's weight attribute in ascending order. - Show recent posts on home page if the value is set to
recent - Do not show anything if the variable is unset or an empty string.
Icons in header
We have used feather as our icons library. Here is an example of how to add custom icons in the header:
[[menu.main]]
identifier = "github"
url = "https://github.com"
weight = 3
# We use feather-icons
pre = "<span data-feather='github'></span>"
Custom Head HTML
The goal of this feature is to give the user more control over the theme. It's functioning is very straightforward - "You can inject any HTML you want in the <head> tag" . This may seem simple at first, but it opens up a lot of possibilities.
Bring your own scripts
Add your own JavaScript or CSS by putting them in the static/ folder and importing them into your HTML.
[params]
customHeadHTML = """
<script>console.log("Custom script or import");</script>
<script src="/js/custom.js"></script>
"""
Analytics
Integration with any analytics tool: This was a personal pet peeve. User privacy is our primary concern and this meant not using Google Analytics or any of the popular tools.
We preferred privacy friendly tools like Umami & Fathom Analytics, but the downside was that no theme supported them out of the box which led to either changing the theme source code or contributing supporting code to the original theme (both of which are good ways to extend the theme, but not our ideal choice)
Giving users the freedom to add anything in the HTML via config.toml seemed like an elegant way to solve the problem.
[params]
customHeadHTML = """
<script async defer data-website-id="website-id" src="https://analytics.example.com/script.js"></script>
"""
Syntax Highlighting
Hugo lets you choose the color scheme for the codeblocks. You can choose from the options here: https://xyproto.github.io/splash/docs/all.html
After choosing your theme, just update the pygmentsStyle attribute in config.toml.
pygmentsStyle = "monokai"
You can read more about syntax highlighting on the official hugo docs.
Site Metadata
Gokarna enables you to improve the SEO performance of your website with minimal effort.
Image preview
We make sure your pages are social media ready.
---
title: "Hello, world!"
image: "/path/to/image.png"
---
Note: If no image is specified in the markdown metadata, the site avatar is automatically used instead.
SEO keywords
The keywords relevant for SEO are composed of the page tags as defined below:
---
title: "Hello, world!"
tags: ["hello", "world"]
---
and the metaKeywords specified in the config.toml:
[params]
metaKeywords = ["blog", "gokarna", "hugo"]