Fork of https://github.com/colorchestra/smol customized for my own needs.

Find a file

colorchestra 4129f82cd7 fix error in theme.toml		2021-08-10 23:47:45 +02:00
archetypes	add initial posts archetype	2021-08-10 23:35:33 +02:00
images	better screenshots	2020-05-28 21:40:04 +02:00
layouts	Merge pull request #8 from pfandzelter/add-image-captions	2020-11-18 18:21:45 +01:00
static/css	images now centered	2021-08-03 22:35:45 +02:00
LICENSE.md	fix LICENSE.md	2020-05-28 21:42:24 +02:00
README.md	add demo page, image caption and copyright info	2020-12-29 23:04:37 +01:00
theme.toml	fix error in theme.toml	2021-08-10 23:47:45 +02:00

README.md

smol

A minimal, monospaced blogging theme for Hugo that respects your privacy and is easy on your bandwidth. A demo can be found at https://smol-demo.morph.sh.

smol is based on Blank created by Vimux.

Features

No JavaScript
No Google spyware or tracking of any kind
No other external dependencies, embedded fonts or comment sections
Dark mode support (depending on your OS's setting)

Installation

In your Hugo site themes directory, run:

git clone https://github.com/colorchestra/smol

Next, open config.toml in the base of the Hugo site and ensure the theme option is set to smol.

theme = "smol"

Lastly, add the following lines to your config.toml to set site parameters and make use of all the menu entries in the header and footer sections if you need them.

# Parameters
[params]
    subtitle = "Your blog subtitle goes here!"
    dateFmt = "02.01.2006 15:04"

# Header
[menu]
  [[menu.main]]
        identifier = "posts"
        name = "Posts"
        url = "/posts/"
        weight = 1 

  [[menu.main]]
        identifier = "categories"
        name = "Categories"
        url = "/categories/"
        weight = 2 

  [[menu.main]]
        identifier = "tags"
        name = "Tags"
        url = "/tags/"
        weight = 3

# Footer
  [[menu.footer]]
        name = "Github"
        url = "https://github.com/example"
        weight = 1 

    [[menu.footer]]
        name = "Mastodon"
        url = "https://example.com/@user"
        weight = 2 

    [[menu.footer]]
        name = "Imprint"
        url = "/imprint"
        weight = 3

For more information read the official quick start guide of Hugo.

Optional features

Custom copyright text

Add copyright = "Your text here" - in the config.toml to change the copyright notice in the footer.

Image captions

You can add captions to images (technically using <figcaption> HTML tags) by adding titles, like so: ![Alt text here](/path/to/image.png "Put your caption here!")

Contributing

Have you found a bug or got an idea for a new feature? Feel free to use the issue tracker to let me know. Or make directly a pull request.

License

This theme is released under the MIT license.