https://github.com/chrede88/qubttemplate

Template for Qubt Hugo Theme
https://github.com/chrede88/qubttemplate

hugo hugo-blog hugo-site hugo-theme

Last synced: about 1 month ago
JSON representation

Template for Qubt Hugo Theme

• Host: GitHub
• URL: https://github.com/chrede88/qubttemplate
• Owner: chrede88
• License: mit
• Created: 2023-11-25T14:22:26.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-12-23T05:03:18.000Z (about 1 month ago)
• Last Synced: 2024-12-23T08:38:05.819Z (about 1 month ago)
• Topics: hugo, hugo-blog, hugo-site, hugo-theme
• Homepage: https://chrede88.github.io/qubt
• Size: 23.6 MB
• Stars: 8
• Watchers: 1
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Qubt - Template

This is the theme template repository! **Please** follow the installation instructions below.

If you're looking for the actual theme repository, follow this [link](https://github.com/Chrede88/qubt).

## Installation

1) Use this template by pressing `Use this template`. **Don't fork this repository!**

2) Wait 20s-30s and update the page. The `Clean Template` workflow will run automatically, creating/poplutating files based on your Github user.

3) Add a LICENSE to your repo.

4) Clone your version of the template to your local computer:

```shell

git clone https://github.com//

```

5) Change the module name to match your github repo in `go.mod`.

6) Modify `config/_default/hugo.yaml`, `config/_default/params.yaml` and `config/_default/menus.yaml` according to to your needs. Find more info on the theme [wiki](https://github.com/chrede88/qubt/wiki/Configuration).

7) Add your blog posts to `content/blog/`. See the [wiki](https://github.com/chrede88/qubt/wiki/Content) or example posts for reference.

8) Modify `content/about.md` so it matches your preferences.

10) Build a local version of your site by executing `hugo server`. You can see the site by navigating to `localhost:1313` (actual URL will be outputted in the CLI) in a browser.

---

## Features

- Simple personal blog theme, designed for mobile-first.

- Automatic dark mode (based on system setttings).

- Emoji support for a fun design.

- Healthcheck endpoint (/healthcheck.json).

---

## Configuration

See the [wiki](https://github.com/chrede88/qubt/wiki) for all info about configuration and how to easily deploy to Github Pages.

---

## Update the Theme Version

The theme version used to build the site is defined in `go.mod` file.

The best practice is to update to released and tested versions. To update to a specific version execute the following command in a terminal/commandline (at the root path of your site repo):

```shell

  hugo mod get github.com/chrede88/[email protected]

```

Replace X,Y & Z with the corresponding version numbers. You can find the releases [here](https://github.com/chrede88/qubt/releases). Please check if any breaking changes are listed under the release you want to update to, before proceeding.