Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/onweru/hugo-swift-theme
A simple open source theme for publishing with hugo
https://github.com/onweru/hugo-swift-theme
deeplinks gallery hugo hugo-theme lazy-loading sass staticman
Last synced: 5 days ago
JSON representation
A simple open source theme for publishing with hugo
- Host: GitHub
- URL: https://github.com/onweru/hugo-swift-theme
- Owner: onweru
- License: other
- Created: 2019-02-14T21:49:30.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-04-05T18:05:11.000Z (9 months ago)
- Last Synced: 2024-12-18T20:07:39.115Z (13 days ago)
- Topics: deeplinks, gallery, hugo, hugo-theme, lazy-loading, sass, staticman
- Language: JavaScript
- Homepage: https://neuralvibes.com/
- Size: 3.55 MB
- Stars: 120
- Watchers: 6
- Forks: 64
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](#staticman-comments)
* [reCAPTCHA](https://developers.google.com/recaptcha/docs/display)
## Prerequisites
This theme uses `sass`. Ensure you have the [extended version of hugo](https://github.com/gohugoio/hugo/releases) installed or in your pipeline.
## Installation
Add this theme as a Git submodule inside your Hugo site folder:
```bash
git submodule add https://github.com/onweru/hugo-swift-theme.git themes/hugo-swift-theme
```
## Configuration
You can configure the site using as follows:
1. ### Global Settings & Staticman
Use the file `hugo.toml`.
2. ### menu, footer
See the **hugo.toml** file's menu areas.
> Follow the `exampleSite/`.
3. Customize Theme colors
You can do so easily in the [variables sass partial](https://github.com/onweru/hugo-swift-theme/blob/e5af8a1414cd8e1ec5a0817f8e5eb8c8c98e2676/assets/sass/_variables.sass#L13-L21). Use names (e.g red, blue, darkgoldenrod), rgb, rgba, hsla or hex values.
## Staticman Comments
By default, [Staticman](https://staticman.net) comments are disabled.
To enable them, you may refer to the
[Staticman config Wiki](https://github.com/onweru/hugo-swift-theme/wiki/staticman-config).
## Written By Block
### How do I include a `written by` ?
1. Copy [this authors yaml file](https://github.com/onweru/hugo-swift-theme/blob/master/exampleSite/data/authors.yml) from the `exampleSite` into your sites `./data` directory.
```toml
[[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"
```
2. Specify the name in your content files
```yaml
...
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 hugo.toml file helps you:
1. 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.
2. 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 :smiley: 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):
1. __Video__
This shortcode can be used to embed a youtube video with custom styling. It takes a solo positional parameter.
```
...
{{< video "youtubeVideoID" >}}
...
```
2. __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" >}}
...
```
3. __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](https://github.com/onweru/hugo-swift-theme/blob/master/LICENSE.md).