Skip to content

README.md

Latest commit

 

History

History
57 lines (35 loc) · 1.8 KB

README.md

File metadata and controls

57 lines (35 loc) · 1.8 KB

Minimal

This is a fork of the original minimal Personal blog theme powered by Hugo. I want to change a few things e.g. remove unneccessary java script, hence the fork.

A live demo of the original theme is available here.

Installation

In the past themes were installed as submodules. This is no longer recommended. Better add it as a hugo module.

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 using the standard hugo highlighting by means of the hugo shortcode.