kancer.club website theme
Go to file
Wilfried OLLIVIER 7ac2fdb1ec Move LICENSE file 2019-07-25 20:31:45 +02:00
archetypes Bootstrap all the things 2018-03-19 00:02:48 +01:00
layouts Fix #1 : no more warnings 2019-04-10 15:07:05 +02:00
static/css Add images hack to main CSS 2018-03-22 11:22:38 +01:00
.gitignore Add DS_Store to git ignore 2018-03-19 08:27:32 +01:00
LICENSE Move LICENSE file 2019-07-25 20:31:45 +02:00
README.md Bootstrap all the things 2018-03-19 00:02:48 +01:00
theme.toml Bootstrap all the things 2018-03-19 00:02:48 +01:00

README.md

KC

Personal blog theme powered by Hugo.

Inspired by Minimal

This theme is a fork of the theme "Minimal", created by Calin Tataru. A live demo is available here. Full source code is here

Installation

You can install the theme either as a clone or submodule.

I recommend the latter. From the root of your Hugo site, type the following:

$ git submodule add https://git.stdcall.me/kancer.club/theme.git themes/kc
$ git submodule init
$ git submodule update

Now you can get updates to KC in the future by updating the submodule:

$ git submodule update --remote themes/kc

Features

You can tweak the look of the theme to suit your needs in a number of ways:

  • The accent colour can be changed by using the accent field in config.toml.

  • You can also change the background colour by using backgroundColor.

  • Add colored 5px borders at the top and bottom of pages by setting showBorder to true.

For best results, I recommend you use a dark accent colour with a light background, for example:

[params]
    accent = "red"
    showBorder = true
    backgroundColor = "white"

Fonts

The theme uses Google Fonts to load its font. To change the font:

[params]
    font = "Raleway" # should match the name on Google Fonts!

Syntax highlighting

The theme supports syntax highlighting thanks to highlight.js.

It's disabled by default, so you have to enable it by setting highlight to true in your config.

You can change the style used for the highlighting by using the highlightStyle field.

Only the "common" languages will be loaded by default. To load more, use highlightLanguages.

A list of all the available styles and languages can be found here.

Please note the style and languages should be written in hyphen-separated lowercase, for example:

[params]
    highlight = true
    highlightStyle = "solarized-dark"
    highlightLanguages = ["go", "haskell", "kotlin", "scala", "swift"]