Personal blog theme powered by Hugo
Switch branches/tags
Nothing to show
Clone or download
Latest commit 488ca07 May 27, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
archetypes Added default archetype Jul 8, 2017
exampleSite Add google analytics Sep 28, 2017
images Updated images with new font Jul 31, 2017
layouts Favicon is now optional Mar 11, 2018
static/css Support for a profile picture on home page (closes #29) Dec 14, 2017
.gitignore Ignores .vscode directory Aug 20, 2017
LICENSE.md Updated license Jul 31, 2017
README.md Fix typo (#71) May 27, 2018
theme.toml Added theme metadata in theme.toml Jul 8, 2017

README.md

Minimal

Personal blog theme powered by Hugo. A live demo is available 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://github.com/calintat/minimal.git themes/minimal
$ git submodule init
$ git submodule update

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

$ git submodule update --remote themes/minimal

Configuration

After installation, take a look at the exampleSite folder inside themes/minimal.

To get started, copy the config.toml file inside exampleSite to the root of your Hugo site:

$ cp themes/minimal/exampleSite/config.toml .

Now edit this file and add your own information. Note that some fields can be omitted.

I recommend you use the theme's archetypes so now delete your site's archetypes/default.md.

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"]