Kiera - A Hugo Theme for writing
Switch branches/tags
Nothing to show
Clone or download
avianto Merge pull request #8 from grayside/extensible-header
Make the header partial extensible.
Latest commit ef5163d Nov 30, 2017

README.md

Kiera Theme for Hugo

Kiera is the theme specialized in presenting writing layout like long essay or technical writing.

Main Features

  • 4 image placements with figure support using shortcodes.
  • Excellent code highlight support thanks to Hugo Chroma.
  • Use Font Awesome for icons (Cloudflare CDN)
  • Utilize normalize.css for consistent styling (Cloudflare CDN)
  • Use Google Fonts: Ruda (serif) and Roboto Slab (sans-serif)
  • Disqus comment loaded on demand

Demo

Live demo: https://avianto.github.io/hugo-kiera/

Installation

Change into Hugo directory then:

$ cd themes
$ git clone https://github.com/avianto/hugo-kiera.git kiera

More detailed instruction at Hugo Docs.

Using git submodule is recommended instead of git clone as per recommendation from Netlify.

$ cd themes
$ git submodule add https://github.com/avianto/hugo-kiera.git kiera

Configuration

For reference look inside folder exampleSite for content example and config.toml.

Important: delete or move archetypes folder from root unless it is necessary. Current Hugo priority lookup will look into this folder first before any other archetypes folder and could cause problem.

Recommended optional config.toml:

pygmentsCodeFences = true

disqusShortname = "" #Disqus shortname
googleAnalytics = "" #Google Analytics ID

[author]
    name = ""       #Author name
    github = ""     #Github username
    gitlab = ""     #Gitlab username
    linkedin = ""   #LinkedIn username
    facebook = ""   #Facebook username
    twitter = ""    #Twitter username
    instagram = ""  #Instagram username

[params]
    tagline = "the tagline for this website"

Main Menu

Add regular non-posts related page (eq. About page) to main menu by adding these lines to the page front matter:

TOML:

menu = "main"
meta = "false"

YAML:

menu: "main"
meta: "false"

meta refers to time, categories, tags and reading time which are not necessary for this kind of page.

For posts listing page, add _index.md file inside content\posts folder with these front matter:

TOML:

+++
title = "Posts"
menu = "main"
weight = "10"
+++

Categories & Tags

Both can be used, also can use only one of them or neither.

Images

Kiera supports adding image as img tag with standard Markdown:

![Image Title](link/to/image)

to wrap it with figure use:

{{< figure src="/link/to/image" >}}

The basic placement is 100% width within content and scaled accordingly in smaller screen. Recommended width for image is 600 pixels minimum.

Kiera supports different placement by adding:

  • For img, use ![Image Title](link/to/image#placement)
  • For figure, use {{< figure src="/link/to/image" class="placement" >}}

There are 4 configured placements

  • #full or class="full" for full width.
  • #mid or class="mid" for middle:
  • #float or class="float" for float left:
  • #float-right or class="float-right" for float right:

Code Hightlight

Using fenced code with Chroma support.

Font Awesome icons

For usage, refer to Font Awesome.

Disqus On Demand

Disqus comments are loaded on demand, by clicking View Comments button.

Support and Pull Requests

Please use GitHub issues to file bugs. If you can help fixing bugs, optimize the theme or adding features, please do pull requests, I really love to see what others can come up with.

TO DO

  • /layout/_default/terms.html needs some works, it functions now, barely.
  • Adding some user-oriented behavior using JavaScripts.
  • Lazyload images.
  • i18n support