Swift Theme

This theme is designed for blogging purposes. Feel free to extend it for other use cases though.

At its core, it's minimalistic; it doesn't rely on monolithic libraries such e.g jquery, bootstrap. Instead, it uses grid css, flexbox & vanilla js to facilitate the features outlined below:

Features

Blog
Pagination
Deeplinks
Dark Mode
Syntax Highlighting
Gallery Support
Native lazy loading of images
Staticman
- reCAPTCHA

Prerequisites

This theme uses sass. Ensure you have the extended version of hugo installed or in your pipeline.

Installation

Add this theme as a Git submodule inside your Hugo site folder:

git submodule add https://github.com/onweru/hugo-swift-theme.git themes/hugo-swift-theme

Configuration

You can configure the site using as follows:

Global Settings & Staticman

Use the file config.toml.
menu, footer

See the config.toml file's menu areas.

Follow the exampleSite/.
Customize Theme colors You can do so easily in the variables sass partial. Use names (e.g red, blue, darkgoldenrod), rgb, rgba, hsla or hex values.

Staticman Comments

By default, Staticman comments are disabled. To enable them, you may refer to the Staticman config Wiki.

Written By Block

How do I include a `written by` ?

Copy this authors yaml file from the exampleSite into your sites ./data directory.

  [[params.authors]]
    name = "yourName" # if fullName 👇🏻 isn't set, name will be displayed on author card
    fullName = "Your Full Name" # optional. If set, it will display on author card
    bio = "It's time to flex. Write a short or not-so-short summary about yourself."
    photo = "myPhotoFile.jpg"
    url = "https://myURLofChoice.domain"

Specify the name in your content files

...
author: "yourName" # case sensitive. must match the name value in your saved data 
...

What if I want to exclude the `written by` from some articles?

Don't include an author in your article front matter.

The [[.Params.authors]] interface in the config.toml file helps you:

Write all your author information in one place. This way, you only specify the author name on your content files (posts). The rest of the data i.e photo, url & bio are automatically pulled from the data file.
In certain situations, you may have different people publishing articles on your blog. For example, you could have someone guest blog. Or may be you have a blog co-author.

Deeplinks

For all content published using markdown, deeplinks will be added to the pages so that you can share with precision 😃 Just hover on a heading and the link button will pop. Click it to copy.

Dark Mode

Today most operating systems & browsers support dark mode. Like twitter, which automatically turns into dark mode when the user chooses darkmode, this theme does the same thing.

Custom Shortcodes

This theme ships with two custom shortcodes (they both use positional parameters):

Video This shortcode can be used to embed a youtube video with custom styling. It takes a solo positional parameter.
```
...
{{< video "youtubeVideoID" >}}
...
```
Picture You want to use darkmode images when darkmode is enabled on a device and a regular image on lightmode? It takes 3 positional parameters

Store these images in the static/images directory.
```
...
{{< picture "lightModeImage.png" "darkModeImage.png" "Image alt text" >}}
...
```
Gallery Include inline galleries within your articles. These galleries can contain N number of images. It takes 2 positional parameters.

The 1st parameter is required. It's a comma-separated list (,) of your images' paths.

The 2nd parameter is optional. It's a double-collon-separated list (::) of your images' alt/description/captions text. It's always a good SEO practice to include alt text for your images.
```
...
{{< gallery "image1Path.png,image3Path.webp,image4Path.jpg" "A PNG gallery image::A WEBP gallery image::A JPEG gallery image" >}}
...
```
For legibility, you can include a space after the delimiters , & ::

License

The code is available under the MIT license.

zwdgit/hugo-swift-theme